Menyiapkan metrik sisi klien

Halaman ini menjelaskan cara menginstal, menyiapkan, dan menggunakan metrik sisi klien Bigtable.

Untuk mengaktifkan dan melihat metrik sisi klien, Anda harus menggunakan library klien Cloud Bigtable untuk Java, yang memanggil API layanan Cloud Bigtable, atau klien HBase Cloud Bigtable untuk Java, yang menggunakan HBase API open source.

Untuk ringkasan, lihat Ringkasan metrik sisi klien. Untuk daftar metrik yang mendetail, lihat Deskripsi metrik sisi klien.

Sebelum memulai

Opsional: Jika saat ini Anda menggunakan integrasi OpenCensus Stats untuk mendapatkan metrik Bigtable, kembalikan dependensi dan perubahan StackdriverStatsExporter dalam aplikasi Anda. Untuk memahami alasannya, lihat Kapan harus melakukan upgrade.

Tambahkan atau konfirmasi izin akun layanan

Untuk menambahkan izin IAM ke akun layanan, selesaikan hal berikut:

  1. Di konsol Google Cloud, buka halaman IAM.

    Buka IAM

  2. Pilih project tempat Anda membuat cluster Bigtable.

  3. Telusuri akun layanan yang ingin Anda tambahkan izin.

  4. Klik Edit akun utama.

  5. Klik Tambahkan peran lain.

  6. Telusuri "monitoring metric writer" dan pilih hasilnya.

  7. Klik Save.

Mengaktifkan Cloud Monitoring API

  1. Di konsol Google Cloud, buka halaman APIs & Services.

    Buka API & Layanan

  2. Pilih project tempat Anda membuat cluster Bigtable.

  3. Klik Enable APIs and Service.

  4. Telusuri "Monitoring".

  5. Di hasil penelusuran, klik ke "Stackdriver Monitoring API".

  6. Jika "API enabled" ditampilkan, berarti API sudah diaktifkan. Jika tidak, klik Enable.

Menyiapkan dan menggunakan library klien Cloud Bigtable untuk Java

Ikuti langkah-langkah berikut jika Anda menggunakan library klien Cloud Bigtable untuk Java, yang memanggil Cloud Bigtable API.

Menginstal dan mengonfigurasi library klien untuk Java

  1. Download dan instal library klien Cloud Bigtable untuk Java. Anda harus memiliki versi 2.16.0 atau yang lebih tinggi untuk menggunakan metrik sisi klien.

  2. Update file pom.xml library klien Java agar menggunakan versi terbaru. Pom Anda akan terlihat seperti berikut:

    <dependencyManagement>
    <dependencies>
        <dependency>
              <groupId>com.google.cloud</groupId>
              <artifactId>google-cloud-bigtable-bom</artifactId>
              <version>2.38.0</version>
              <scope>import</scope>
              <type>pom</type>
          </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
          <groupId>com.google.cloud</groupId>
          <artifactId>google-cloud-bigtable</artifactId>
    </dependency>
</dependencies>

Mengaktifkan metrik sisi klien di aplikasi Anda

Saat Anda membuat klien menggunakan library klien, aktifkan metrik bawaan. Kode Anda akan terlihat seperti berikut:

  BigtableDataSettings settings = BigtableDataSettings.newBuilder()
              .setProjectId("our-project-2-12")
              .setInstanceId("our-instance-85")
              .setAppProfileId("our-appProfile-06")
              .build();

  BigtableDataSettings.enableBuiltinMetrics();

  try (BigtableDataClient client = BigtableDataClient.create(settings)) {
          // Application logic
  }

Menyiapkan instance OpenTelemetry kustom

Jika menggunakan versi 2.38.0 atau yang lebih baru, dan ingin memublikasikan metrik sisi klien ke Cloud Monitoring dan sink kustom, Anda dapat menyiapkan instance OpenTelemetry kustom.

  SdkMeterProviderBuilder meterProviderBuilder = SdkMeterProvider.builder();

  // register client side metrics on your meter provider
  BuiltinMetricsView.registerBuiltinMetrics("my-project-id", meterProviderBuilder);

  // register other metric reader and views
  meterProviderBuilder.registerMetricReader().registerView();

  // create the OTEL instance
  OpenTelemetry openTelemetry = OpenTelemetrySdk.builder()
          .setMeterProvider(meterProviderBuilder.build())
          .build();

  // Override MetricsProvider in BigtableDataSettings
  BigtableDataSettings settings = BigtableDataSettings.newBuilder()
          .setProjectId("my-project-id")
          .setInstanceId("my-instance-id")
          .setMetricsProvider(CustomOpenTelemetryMetricsProvider.create(openTelemetry))
          .build();

  try (BigtableDataClient client = BigtableDataClient.create(settings)) {
        // Application logic
  }

Menyiapkan dan menggunakan klien HBase Cloud Bigtable untuk Java

Ikuti langkah-langkah berikut jika Anda menggunakan klien HBase Cloud Bigtable untuk Java, yang memanggil HBase API, untuk menghubungkan aplikasi Anda ke Bigtable.

Menginstal dan mengonfigurasi library klien HBase untuk Java

  1. Download dan instal klien HBase Cloud Bigtable untuk Java. Untuk mengaktifkan metrik sisi klien, Anda harus menggunakan versi 2.6.4 atau yang lebih baru.

  2. Buat project Maven kosong.

  3. Tentukan dependensi artefak yang tepat untuk kasus penggunaan Anda. Versi 2.x menyertakan klien asinkron HBase yang tidak dimiliki versi 1.x.

    • bigtable-hbase-1.x atau bigtable-hbase-2.x: Gunakan untuk aplikasi mandiri yang Anda gunakan untuk mengontrol dependensi.
    • bigtable-hbase-1.x-hadoop atau bigtable-hbase-2.x-hadoop: Gunakan di lingkungan Hadoop.
    • bigtable-hbase-1.x-shaded atau bigtable-hbase-2.x-shaded: Gunakan di lingkungan selain Hadoop yang memerlukan versi komponen lama seperti protobuf atau Guava.

  4. Perbarui file pom.xml:

    <dependencyManagement>
    <dependencies>
        <dependency>
              <groupId>com.google.cloud.bigtable</groupId>
              <artifactId>BIGTABLE_HBASE_ARTIFACT</artifactId>
              <version>VERSION_NUMBER</version>
          </dependency>
    </dependencies>
</dependencyManagement>

    Berikan hal berikut:

    • BIGTABLE_HBASE_ARTIFACT: dependensi artefak untuk project Anda, yang diformat seperti bigtable-hbase-1.x atau bigtable-hbase-2.x-hadoop.
    • VERSION_NUMBER: versi library klien yang Anda gunakan, dengan format seperti 2.6.4

Mengaktifkan metrik sisi klien di aplikasi Anda

Menggunakan bigtable-hbase-1.x atau bigtable-hbase-2.x

Saat membuat koneksi menggunakan library klien HBase dan artefak bigtable-hbase-1.x atau bigtable-hbase-2.x, kode untuk mengaktifkan metrik sisi klien bawaan akan terlihat seperti berikut:

  import com.google.cloud.bigtable.data.v2.BigtableDataSettings;

  Configuration configuration = BigtableConfiguration.configure("my-project-id", "my-instance-id");
  Connection connection = new BigtableConnection(configuration);

  BigtableDataSettings.enableBuiltinMetrics();

Menggunakan artefak -hadoop atau -shaded

Saat membuat koneksi menggunakan library klien HBase dan salah satu artefak -hadoop atau -shaded, kode Anda untuk mengaktifkan metrik sisi klien bawaan akan terlihat mirip dengan yang berikut ini:

  import com.google.bigtable.repackaged.com.google.cloud.bigtable.data.v2.BigtableDataSettings;

  Configuration configuration = BigtableConfiguration.configure("my-project-id", "my-instance-id");
  Connection connection = new BigtableConnection(configuration);

  BigtableDataSettings.enableBuiltinMetrics();

Melihat metrik di Metrics Explorer

  1. Di Konsol Google Cloud, buka halaman Metrics Explorer.

    Buka Metrics Explorer

  2. Pilih project.

  3. Klik Select a metric.

  4. Telusuri bigtable.googleapis.com/client.

  5. Pilih metrik, metode group by, dan status, lalu pilih Agregator. Untuk mempelajari opsi lainnya, lihat Memilih metrik saat menggunakan Metrics Explorer.

Setelah mengaktifkan metrik sisi klien, biarkan aplikasi berjalan setidaknya selama satu menit sebelum Anda memeriksa metrik yang dipublikasikan.

Langkah selanjutnya