Configura le metriche lato client

Questa pagina descrive come installare, configurare e utilizzare Bigtable lato client metriche di valutazione.

Le metriche lato client sono disponibili per gli utenti delle seguenti librerie client:

• Libreria client Bigtable per Java
• Client Bigtable HBase per Java
• Libreria client Bigtable per Go

Per una panoramica, consulta la Panoramica delle metriche lato client. Per un elenco dettagliato delle metriche, consulta Descrizioni delle metriche lato client.

Aggiungi o conferma le autorizzazioni dell'account di servizio

Nota: le autorizzazioni IAM per gli autori di metriche sono incluse nei ruoli predefiniti di Bigtable per impostazione predefinita. Questo passaggio è necessaria solo se utilizzi una ruolo personalizzato.

Per aggiungere le autorizzazioni IAM all'account di servizio, svolgi i seguenti passaggi:

1. Nella console Google Cloud, vai alla pagina IAM.

   Vai a IAM

2. Seleziona il progetto in cui hai creato il cluster Bigtable.

3. Cerca l'account di servizio a cui vuoi aggiungere l'autorizzazione.

4. Fai clic su Modifica entità.

5. Fai clic su Aggiungi un altro ruolo.

6. Cerca "writer metriche di monitoraggio" e seleziona il risultato.

7. Fai clic su Salva.

Abilita l'API Cloud Monitoring

1. Nella console Google Cloud, vai alla pagina API e servizi.

   Vai su API e servizi

2. Seleziona il progetto in cui hai creato il cluster Bigtable.

3. Fai clic su Abilita API e servizio.

4. Cerca "Monitoraggio".

5. Nei risultati di ricerca, fai clic su "API Stackdriver Monitoring".

6. Se viene visualizzato il messaggio "API abilitata", significa che l'API è già abilitata. In caso contrario, fai clic su Attiva.

Configura la libreria client Bigtable

Dopo aver attivato l'API Cloud Monitoring, configura la libreria client Bigtable.

Vai

Segui questi passaggi se utilizzi Bigtable per Go, che chiama le API Bigtable.

Installa e configura la libreria client per Go

Aggiorna la libreria client Bigtable per Go to versione 1.27.0 o in un secondo momento. go.mod dovrebbe avere il seguente aspetto:

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

(Facoltativo) Disattivare le metriche lato client

Le metriche lato client sono abilitate per impostazione predefinita nella libreria client Go. Per disattivarla, passa NoopMetricsProvider in ClientConfig:

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

HBase

Segui questi passaggi se utilizzi il client Bigtable HBase per Java, che chiama l'API HBase, per connettere la tua applicazione Bigtable.

Installa e configura la libreria client HBase per Java

1. Scarica e installa la versione più recente del client Bigtable HBase per Java. Per attivare le metriche lato client, devi utilizzare la versione 2.6.4 o successive.

2. Crea un progetto Maven vuoto.

3. Determina la dipendenza degli artefatti più adatta al tuo caso d'uso. Le versioni 2.x includono un client asincrono HBase che non è presente nelle versioni 1.x.

   • bigtable-hbase-1.x o bigtable-hbase-2.x: da utilizzare come versione autonoma e applicazioni in cui hai il controllo delle tue dipendenze.
   • bigtable-hbase-1.x-hadoop o bigtable-hbase-2.x-hadoop: utilizza in Hadoop ambienti cloud-native.
   • bigtable-hbase-1.x-shaded o bigtable-hbase-2.x-shaded: da utilizzare in ambienti diversi da Hadoop che richiedono versioni precedenti di componenti come protobuf o Guava.

4. Aggiorna il file pom.xml:

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

   Fornisci quanto segue:

   • BIGTABLE_HBASE_ARTIFACT: la dipendenza dall'elemento per il progetto, formattata come bigtable-hbase-1.x o bigtable-hbase-2.x-hadoop.
   • VERSION_NUMBER: la versione della libreria client in uso, formattata come 2.6.4

Attiva le metriche lato client nella tua applicazione

Nota: le metriche lato client sono abilitate per impostazione predefinita dalla versione 2.14.1. La i seguenti passaggi sono necessari solo se utilizzi una versione compresa tra la 2.6.4 e 2.14.1.

In uso: bigtable-hbase-1.x o bigtable-hbase-2.x

Quando crei una connessione utilizzando la libreria client HBase e bigtable-hbase-1.x o bigtable-hbase-2.x artefatti, il codice da abilitare le metriche integrate lato client sono simili alle seguenti:

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

Utilizzo di -hadoop o -shaded elementi

Quando crei una connessione utilizzando la libreria client HBase e uno dei -hadoop o -shaded artefatti, il tuo codice per abilitare il lato client integrato sono simili alle seguenti:

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

(Facoltativo) Disattiva le metriche lato client

Se utilizzi la versione 2.14.1 o successive, le metriche lato client sono abilitate per impostazione predefinita. Puoi disattivare questa funzionalità.

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

Segui questi passaggi se utilizzi Bigtable libreria client per Java, che chiama le API Bigtable.

Prima di iniziare

(Facoltativo) Se utilizzi un sistema OpenCensus Statistiche per ottenere le metriche Bigtable, ripristinare la dipendenza StackdriverStatsExporter modifiche nell'applicazione. Per capire il motivo, consulta Quando eseguire l'upgrade.

Installa e configura la libreria client per Java

1. Scarica e installa la libreria client di Bigtable per Java. Devi avere la versione 2.16.0 o successiva per utilizzare le metriche lato client.

2. Aggiorna il file pom.xml della libreria client Java per utilizzare la versione più recente. Il tuo pom dovrebbe essere simile al seguente:

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

Attivare le metriche lato client nell'applicazione

Nota: le metriche lato client sono abilitate per impostazione predefinita dalla versione 2.38.0. Questo passaggio è necessaria solo se utilizzi una versione compresa tra 2.16.0 e 2.38.0.

Quando crei un client utilizzando la libreria client, attiva le metriche predefinite. Il codice dovrebbe essere simile al seguente:

  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
  }

Configura un'istanza OpenTelemetry personalizzata

Se utilizzi la versione 2.38.0 o successive e vuoi pubblicare le metriche lato client in Cloud Monitoring e in sink personalizzati, puoi configurare un'istanza OpenTelemetry personalizzata.

  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
  }

(Facoltativo) Disattiva le metriche lato client

Se utilizzi la versione 2.38.0 o successive, puoi disattivare l'utilizzo delle metriche lato client.

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

Visualizza le metriche in Metrics Explorer

1. Nella console Google Cloud, vai alla pagina Esplora metriche.

   Vai a Esplora metriche

2. Seleziona il progetto.

3. Fai clic su Seleziona una metrica.

4. Cerca bigtable.googleapis.com/client.

5. Seleziona una metrica, un metodo group by e uno stato, poi scegli un aggregatore. Per esplorare altre opzioni, vedi Seleziona le metriche quando utilizzi Esplora metriche.

Dopo aver abilitato le metriche lato client, consenti l'esecuzione dell'applicazione per almeno minuti prima di verificare le metriche pubblicate.

Passaggi successivi

• Leggi una panoramica delle metriche lato client.
• Visualizza descrizioni complete delle metriche lato client.
• Scopri di più sul monitoraggio di Bigtable.