Menyiapkan metrik sisi klien

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

Metrik sisi klien tersedia untuk pengguna library klien berikut:

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

Menambahkan atau mengonfirmasi izin akun layanan

Untuk menambahkan izin IAM ke akun layanan, selesaikan langkah-langkah berikut:

  1. Di konsol Google Cloud, buka halaman IAM.

    Buka IAM

  2. Pilih project tempat Anda membuat cluster Bigtable.

  3. Telusuri akun layanan tempat Anda ingin menambahkan izin.

  4. Klik Edit principal.

  5. Klik Tambahkan peran lain.

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

  7. Klik Simpan.

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 "Pemantauan".

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

  6. Jika "API enabled" ditampilkan, berarti API tersebut sudah diaktifkan. Jika belum, klik Aktifkan.

Menyiapkan library klien Bigtable

Setelah mengaktifkan Cloud Monitoring API, konfigurasikan library klien Bigtable.

Go

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

Menginstal dan mengonfigurasi library klien untuk Go

Update library klien Bigtable untuk Go ke versi 1.27.0 atau yang lebih baru. go.mod Anda akan terlihat seperti berikut:

require (
  cloud.google.com/go/bigtable v1.27.2-0.20240725222120-ce31365acc54

Opsional: Memilih tidak ikut metrik sisi klien

Metrik sisi klien diaktifkan secara default di library klien Go. Untuk memilih tidak ikut, teruskan NoopMetricsProvider di ClientConfig:

client, err := bigtable.NewClientWithConfig(ctx, project, instance,
bigtable.ClientConfig{MetricsProvider: bigtable.NoopMetricsProvider{},
})

HBase

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

Menginstal dan mengonfigurasi library klien HBase untuk Java

  1. Download dan instal klien Bigtable HBase terbaru 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 dapat Anda kontrol dependensinya.
    • 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 komponen versi sebelumnya 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, diformat seperti 2.6.4

Mengaktifkan metrik sisi klien di aplikasi Anda

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

Saat Anda membuat koneksi menggunakan library klien HBase dan artefak bigtable-hbase-1.x atau bigtable-hbase-2.x, kode Anda 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 Anda 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 kode berikut:

  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();

Opsional: Memilih tidak ikut metrik sisi klien

Jika Anda menggunakan versi 2.14.1 atau yang lebih baru, metrik sisi klien diaktifkan secara default. Anda dapat memilih untuk tidak ikut.

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

Java

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

Sebelum memulai

Opsional: Jika Anda menggunakan integrasi OpenCensus Stats untuk mendapatkan metrik Bigtable, kembalikan dependensi dan perubahan StackdriverStatsExporter di aplikasi Anda. Untuk memahami alasannya, lihat Kapan harus mengupgrade.

Menginstal dan mengonfigurasi library klien untuk Java

  1. Download dan instal library klien Bigtable terbaru 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 untuk 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
  }

Opsional: Memilih tidak ikut metrik sisi klien

Jika menggunakan versi 2.38.0 dan yang lebih baru, Anda dapat memilih untuk tidak menggunakan metrik sisi klien.

BigtableDataSettings settings = BigtableDataSettings.newBuilder()
        .setProjectId("my-project")
        .setInstanceId("my-instance")
        .setMetricsProvider(NoopMetricsProvider.INSTANCE)
        .build();

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 Aggregator. 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.

Melihat metrik di pemantauan Bigtable

Diagram untuk metrik sisi klien berikut ditampilkan di halaman pemantauan Bigtable:

  • Latensi baca sisi klien
  • Latensi tulis sisi klien
  • Latensi upaya baca sisi klien
  • Latensi upaya tulis sisi klien

Untuk melihat metrik sisi klien di halaman Monitoring, ikuti langkah-langkah berikut:

  1. Buka daftar instance Bigtable di konsol Google Cloud.

    Buka daftar instance

  2. Klik instance yang metriknya ingin Anda lihat.

  3. Di panel kiri, klik Monitoring. Konsol Google Cloud menampilkan serangkaian diagram untuk instance.

  4. Scroll panel untuk melihat metrik sisi klien.

  5. Opsional: Untuk melihat metrik di tingkat tabel, klik Tabel.

  6. Opsional: Untuk melihat metrik untuk setiap profil aplikasi, klik Profil Aplikasi.

Untuk informasi selengkapnya, lihat Pemantauan Bigtable.

Langkah selanjutnya