Configura le metriche lato client

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

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 è obbligatorio solo se utilizzi un 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 "autore metrica 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 servizi.

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 la libreria client Bigtable per Go, che chiama le API Bigtable.

Installa e configura la libreria client per Go

Aggiorna la libreria client Bigtable per Go alla versione 1.27.0 o successiva. go.mod dovrebbe avere il seguente aspetto:

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

(Facoltativo) Disattiva 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 questa procedura se utilizzi il client Bigtable HBase per Java, che chiama l'API HBase, per connettere la tua applicazione a Bigtable.

Installa e configura la libreria client HBase per Java

1. Scarica e installa l'ultima versione 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 dagli elementi adatta al tuo caso d'uso. Le versioni 2.x include un client asincrono HBase che non è presente nelle versioni 1.x.

   • bigtable-hbase-1.x o bigtable-hbase-2.x: da utilizzare per applicazioni autonome in cui hai il controllo delle dipendenze.
   • bigtable-hbase-1.x-hadoop o bigtable-hbase-2.x-hadoop: da utilizzare negli ambienti Hadoop.
   • 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 dell'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

Attivare le metriche lato client nell'applicazione

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

Utilizzo di bigtable-hbase-1.x o bigtable-hbase-2.x

Quando crei una connessione utilizzando la libreria client HBase e gli elementi bigtable-hbase-1.x o bigtable-hbase-2.x, il codice per attivare le metriche lato client integrate è simile al seguente:

  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 elementi -hadoop o -shaded

Quando crei una connessione utilizzando la libreria client HBase e uno degli elementi -hadoop o -shaded, il codice per attivare le metriche lato client integrate è simile al seguente:

  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 la libreria client Bigtable per Java, che chiama le API Bigtable.

Prima di iniziare

(Facoltativo) Se utilizzi un'integrazione di OpenCensus Stats per ottenere le metriche di Bigtable, ripristina la dipendenza e le modificheStackdriverStatsExporter nell'applicazione. Per capire il motivo, consulta Quando eseguire l'upgrade.

Installa e configura la libreria client per Java

1. Scarica e installa la versione più recente della libreria client Bigtable per Java. Per utilizzare le metriche lato client, devi avere la versione 2.16.0 o successive.

2. Aggiorna il file pom.xml della libreria client Java per utilizzare la versione più recente. Il file pom dovrebbe avere il seguente aspetto:

   <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 è obbligatorio 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
  }

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

Visualizzare 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, consulta Selezionare le metriche durante l'utilizzo di Metrics Explorer.

Dopo aver attivato le metriche lato client, lascia in esecuzione l'applicazione per almeno un minuto prima di controllare se sono state pubblicate.

Visualizzare le metriche nel monitoraggio di Bigtable

Nella pagina di monitoraggio di Bigtable vengono visualizzati i grafici per le seguenti metriche lato client:

• Latenza di lettura sul client
• Latenza di scrittura sul client
• Latenza del tentativo di lettura sul client
• Latenza del tentativo di scrittura sul client

Per visualizzare le metriche lato client nella pagina Monitoraggio:

1. Apri l'elenco delle istanze Bigtable nella console Google Cloud.

   Apri l'elenco delle istanze

2. Fai clic sull'istanza di cui vuoi visualizzare le metriche.

3. Nel riquadro a sinistra, fai clic su Monitoraggio. La console Google Cloud mostra una serie di grafici per l'istanza.

4. Scorri il riquadro per visualizzare le metriche lato client.

5. (Facoltativo) Per visualizzare le metriche a livello di tabella, fai clic su Tables (Tabelle).

6. (Facoltativo) Per visualizzare le metriche dei singoli profili dell'app, fai clic su Profili dell'applicazione.

Per ulteriori informazioni, consulta la sezione Monitoraggio di Bigtable.

Passaggi successivi

• Leggi una panoramica delle metriche lato client.
• Visualizza descrizioni complete delle metriche lato client.