Utilizzare le metriche lato client gRPC

Questa pagina descrive come inviare metriche lato client gRPC a Cloud Monitoring quando utilizzi gRPC per interagire con Cloud Storage utilizzando una delle seguenti interfacce supportate:

Le metriche lato client possono essere utilizzate per monitorare le prestazioni dell'applicazione client che interagisce con Cloud Storage utilizzando gRPC. La metrica lato client è diversa dalle metriche lato server, che forniscono insight sulle prestazioni di Cloud Storage dal punto di vista lato server.

Come funziona

Puoi attivare l'invio di metriche lato client a Cloud Monitoring quando utilizzi gRPC per interagire con Cloud Storage utilizzando una delle interfacce supportate.

Prezzi

Le metriche lato client di Cloud Storage non sono addebitabili, il che significa che puoi emettere, archiviare e accedere alle metriche lato client di Cloud Storage senza incorrere in addebiti di Cloud Monitoring. Per saperne di più sui prezzi, consulta Prezzi di Google Cloud Observability.

Prima di iniziare

Per utilizzare le metriche lato client, devi prima completare i seguenti passaggi:

  1. Verifica che la libreria client o il connettore Cloud Storage che vuoi utilizzare supporti gRPC. Le seguenti librerie client e i seguenti connettori di Cloud Storage supportano gRPC:

  2. Configura l'autenticazione.

  3. Abilita l'API Cloud Monitoring.

  4. Abilita l'API Storage di Cloud Storage.

    Vai all'API Cloud Storage

  5. Imposta i ruoli e le autorizzazioni richiesti per generare metriche lato client.

Ruoli obbligatori

Per impostare le autorizzazioni necessarie per inviare metriche lato client gRPC a Cloud Monitoring, concedi il ruolo IAM Monitoring Metric Writer (roles/monitoring.metricWriter) al service account utilizzato dal client gRPC.

Questo ruolo predefinito contiene le autorizzazioni necessarie per inviare metriche lato client gRPC a Cloud Monitoring. Per vedere quali sono esattamente le autorizzazioni richieste, consulta la sezione Autorizzazioni obbligatorie:

Autorizzazioni obbligatorie

  • monitoring.timeSeries.create

Questa autorizzazione IAM è inclusa nei seguenti ruoli predefiniti di Cloud Storage:

Potresti anche ottenere queste autorizzazioni con altri ruoli personalizzati o ruoli predefiniti. Per saperne di più sul ruolo Monitoring Metric Writer, consulta la documentazione IAM su roles/monitoring.metricWriter.

Descrizioni delle metriche

Le sezioni seguenti descrivono le metriche lato client di Cloud Storage che possono essere utilizzate per monitorare le prestazioni del client gRPC.

Metriche per tentativo del client

Le seguenti metriche raccolgono dati sul rendimento relativi ai singoli tentativi effettuati da un client di comunicare con un server. Le metriche per tentativo del client possono aiutarti a misurare il comportamento dei nuovi tentativi, i colli di bottiglia e a ottimizzare la comunicazione tra un client e un server.

Metrica completa Descrizione Tipo di strumento Unità Attributi
storage.googleapis.com/client/grpc/client/attempt/started Preview: il numero totale di tentativi RPC avviati, inclusi quelli non completati. Contatore {attempt}
  • grpc.method: il nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo.
  • grpc.target: URI di destinazione canonizzato utilizzato durante la creazione del canale gRPC.
storage.googleapis.com/client/grpc/client/attempt/duration Preview. Il tempo end-to-end necessario per completare un tentativo RPC, incluso il tempo necessario per scegliere un sottocanale. Istogramma s
  • grpc.method: nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo.
  • grpc.target: URI di destinazione in formato canonico utilizzato durante la creazione del canale gRPC.
  • grpc.status: codice di stato del server gRPC ricevuto, ad esempio OK, CANCELLED o DEADLINE_EXCEEDED.
  • grpc.lb.locality: la località a cui viene inviato il traffico. Questo valore verrà impostato sull'attributo resolver trasmesso dalla policy weighted_target o sulla stringa vuota se l'attributo resolver non è impostato.
storage.googleapis.com/client/grpc/client/attempt/sent_total_compressed_message_size Preview. I byte totali, compressi ma non criptati, inviati in tutti i messaggi di richiesta, ad eccezione dei metadati per tentativo RPC. Non sono inclusi i byte di framing gRPC o di trasporto. Istogramma By
  • grpc.method: nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo.
  • grpc.target: URI di destinazione in formato canonico utilizzato durante la creazione del canale gRPC.
  • grpc.status: codice di stato del server gRPC ricevuto, ad esempio OK, CANCELLED o DEADLINE_EXCEEDED.
  • grpc.lb.locality: la località a cui viene inviato il traffico. Questo valore verrà impostato sull'attributo resolver trasmesso dalla policy weighted_target o sulla stringa vuota se l'attributo resolver non è impostato.
storage.googleapis.com/client/grpc/client/attempt/rcvd_total_compressed_message_size Preview. I byte totali, compressi ma non criptati, ricevuti in tutti i messaggi di risposta, ad eccezione dei metadati per tentativo RPC. Non sono inclusi i byte di framing gRPC o di trasporto. Istogramma By
  • grpc.method: nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo.
  • grpc.target: URI di destinazione in formato canonico utilizzato durante la creazione del canale gRPC.
  • grpc.status: codice di stato del server gRPC ricevuto, ad esempio OK, CANCELLED o DEADLINE_EXCEEDED.
  • grpc.lb.locality: la località a cui viene inviato il traffico. Questo valore verrà impostato sull'attributo resolver trasmesso dalla policy weighted_target o sulla stringa vuota se l'attributo resolver non è impostato.

Per saperne di più sugli strumenti per tentativo del client, consulta la documentazione sulle metriche di OpenTelemetry su GitHub.

Metriche per chiamata del client

Le seguenti metriche forniscono una visualizzazione aggregata dell'intero ciclo di vita di una chiamata client a un server. Le metriche per chiamata del client forniscono dati di alto livello sulle chiamate del client, metriche di monitoraggio per comprendere i pattern delle chiamate e ti aiutano a identificare le frequenze degli errori.

Metrica completa Descrizione Tipo di strumento Unità Attributi
storage.googleapis.com/client/grpc/client/call/duration Preview. Misura il tempo end-to-end impiegato dalla libreria gRPC per completare un RPC dal punto di vista dell'applicazione. Istogramma s
  • grpc.method: nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo.
  • grpc.target: URI di destinazione in formato canonico utilizzato durante la creazione del canale gRPC.
  • grpc.status: codice di stato del server gRPC ricevuto, ad esempio OK, CANCELLED o DEADLINE_EXCEEDED.

Per saperne di più sugli strumenti per chiamata del client, consulta la documentazione sulle metriche di OpenTelemetry su GitHub.

Metriche di rilevamento del carico delle richieste

Le seguenti metriche forniscono insight sull'efficacia dell'utilizzo del rilevamento del carico delle richieste da parte della tua applicazione client. Le metriche di rilevamento del carico delle richieste possono aiutarti a bilanciare i carichi del server, ottimizzare l'utilizzo delle risorse e migliorare i tempi di risposta dei client. Le seguenti metriche sono disponibili solo con la connettività diretta.

Metrica completa Descrizione Tipo di strumento Unità Attributi
storage.googleapis.com/client/grpc/lb/rls/cache_entries Preview. Il numero di voci nella cache di rilevamento del carico delle richieste. Misuratore {entry}
  • grpc.target: indica la destinazione del canale gRPC in cui viene utilizzato il WRR.
  • grpc.lb.rls.server_target: l'URI di destinazione del server di rilevamento del carico delle richieste con cui comunica.
  • grpc.lb.rls.instance_uuid: un UUID (Universally Unique Identifier) per un'istanza client di rilevamento del carico di richieste individuale. Il valore non è significativo di per sé, ma è utile per distinguere tra le istanze client di rilevamento del carico delle richieste nei casi in cui sono presenti più istanze nello stesso canale gRPC o più canali per lo stesso target.
storage.googleapis.com/client/grpc/lb/rls/cache_size Preview: le dimensioni attuali della cache di rilevamento del carico delle richieste. Misuratore By
  • grpc.target: la destinazione del canale gRPC in cui viene utilizzato il WRR.
  • grpc.lb.rls.server_target: l'URI di destinazione del server di rilevamento del carico delle richieste con cui comunica.
  • grpc.lb.rls.instance_uuid: un UUID per un'istanza client di rilevamento del carico delle richieste individuale. Il valore non è significativo di per sé, ma è utile per distinguere tra le istanze client di rilevamento del carico delle richieste nei casi in cui sono presenti più istanze nello stesso canale gRPC o più canali per lo stesso target.
storage.googleapis.com/client/grpc/lb/rls/default_target_picks Preview: il numero di scelte del bilanciatore del carico (LB) inviate alla destinazione predefinita. Contatore {pick}
  • grpc.target: indica la destinazione del canale gRPC in cui viene utilizzato il rilevamento del carico delle richieste.
  • grpc.lb.rls.server_target: l'URI di destinazione del server di rilevamento del carico delle richieste con cui comunicare.
  • grpc.lb.rls.data_plane_target: una stringa target utilizzata dal rilevamento del carico delle richieste per il routing del traffico del piano dati. Il valore viene restituito dal server di rilevamento del carico delle richieste per una determinata chiave o configurato come target predefinito nella configurazione del rilevamento del carico delle richieste.
  • grpc.lb.pick_result:il risultato di una scelta del bilanciatore del carico, ad esempio "complete", "fail" o "drop".
storage.googleapis.com/client/grpc/lb/rls/target_picks Preview. Il numero di scelte di bilanciamento del carico inviate a ciascun target di rilevamento del carico delle richieste. Se il target predefinito viene restituito anche dal server di rilevamento del carico delle richieste, le RPC inviate a quel target dalla cache vengono conteggiate in questa metrica, non in grpc.rls.default_target_picks. Contatore {pick}
  • grpc.target: la destinazione del canale gRPC in cui viene utilizzato il rilevamento del carico delle richieste.
  • grpc.lb.rls.server_target: l'URI di destinazione del server di rilevamento del carico delle richieste con cui comunicare.
  • grpc.lb.rls.data_plane_target: una stringa target utilizzata dal rilevamento del carico delle richieste per il routing del traffico del piano dati. Il valore viene restituito dal server di rilevamento del carico delle richieste per una determinata chiave o configurato come target predefinito nella configurazione del rilevamento del carico delle richieste.
  • grpc.lb.pick_result: il risultato di una scelta del bilanciatore del carico, ad esempio "complete", "fail" o "drop".
storage.googleapis.com/client/grpc/lb/rls/failed_picks Preview. Il numero di selezioni LB non riuscite a causa di una richiesta di rilevamento del carico della richiesta non riuscita o della limitazione del canale di rilevamento del carico della richiesta. Contatore {pick}
  • grpc.target: la destinazione del canale gRPC in cui viene utilizzato il rilevamento del carico delle richieste.
  • grpc.lb.rls.server_target: l'URI di destinazione del server di rilevamento del carico delle richieste con cui comunicare.

Metriche client del servizio xDiscovery

Le seguenti metriche forniscono informazioni su come l'applicazione client interagisce con il control plane xDiscovery Service (xDS) per rilevare e configurare le connessioni ai servizi di backend. Le metriche xDS possono aiutarti a monitorare la latenza delle richieste di servizio, monitorare gli aggiornamenti della configurazione e ottimizzare le prestazioni xDS complessive.

Le seguenti metriche sono disponibili solo con la connettività diretta.

Metrica completa Descrizione Tipo di strumento Unità Attributi
storage.googleapis.com/client/grpc/xds_client/connected Preview. Misura se il client xDS ha o meno un flusso ADS funzionante verso il server xDS. Per un determinato server, questa metrica viene impostata su 1 al momento della creazione iniziale dello stream. Se si verifica un errore di connettività o se lo stream ADS non va a buon fine senza visualizzare un messaggio di risposta come previsto da A57, la metrica viene impostata su 0. Una volta impostata su 0, la metrica verrà reimpostata su 1 quando viene ricevuta la prima risposta su uno stream ADS. Questa metrica è disponibile solo per le librerie client di Cloud per C++. Misuratore {bool}
  • grpc.target: per i client, indica la destinazione del canale gRPC in cui viene utilizzato XdsClient. Per i server, sarà la stringa "#server".
  • grpc.xds.server: l'URI di destinazione del server xDS con cui comunica XdsClient.
storage.googleapis.com/client/grpc/xds_client/resource_updates_invalid Preview. Il numero di risorse ricevute che sono state considerate non valide. Questa metrica è disponibile solo per le librerie client di Cloud per C++. Contatore {resource}
  • grpc.target: per i client, indica la destinazione del canale gRPC in cui viene utilizzato XdsClient. Per i server, sarà la stringa "#server".
  • grpc.xds.server: l'URI di destinazione del server xDS con cui comunica XdsClient.
  • grpc.xds.resource_type: indica un tipo di risorsa xDS, ad esempio "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/resource_updates_valid Preview: il numero di risorse ricevute considerate valide, anche se invariate. Questa metrica è disponibile solo per le librerie client di Cloud per C++. Contatore {resource}
  • grpc.target: per i client, indica la destinazione del canale gRPC in cui viene utilizzato XdsClient. Per i server, sarà la stringa "#server".
  • grpc.xds.server: l'URI di destinazione del server xDS con cui comunica XdsClient.
  • grpc.xds.resource_type: indica un tipo di risorsa xDS, ad esempio "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/resources Preview: il numero di risorse xDS. Questa metrica è disponibile solo per le librerie client di Cloud per C++. Misuratore {resource}
  • grpc.target: per i client, indica la destinazione del canale gRPC in cui viene utilizzato XdsClient. Per i server, sarà la stringa "#server".
  • grpc.xds.authority: l'autorità xDS. Il valore sarà "#old" per i nomi delle risorse non xdstp identificati nell'API xDS, prima dell'introduzione della rappresentazione URI xdstp://.
  • grpc.xds.cache_state: indica lo stato della cache di una risorsa xDS.
  • grpc.xds.resource_type indica un tipo di risorsa xDS, ad esempio "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/server_failure Preview. Il numero di server xDS che non funzionano più correttamente e sono diventati non disponibili, sovraccarichi o forniscono dati di configurazione errati o non validi. Questa metrica è disponibile solo per le librerie client di Cloud per C++. Contatore {failure}
  • grpc.target: l'URI di destinazione del server xDS con cui comunica XdsClient.
  • grpc.xds.server: per i client, indica la destinazione del canale gRPC in cui viene utilizzato XdsClient. Per i server, si tratta della stringa "#server".

Per saperne di più sulle metriche del client xDS, consulta la documentazione sul bilanciamento del carico globale basato su xDS in GitHub.

Disattiva le metriche lato client

Se necessario, puoi disattivare le metriche lato client.

Java

public GrpcStorageOptions.Builder setEnableGrpcClientMetrics(false enableGrpcClientMetrics)

Per saperne di più, consulta Librerie client di Cloud per il metodo della classe GrpcStorageOptions.Builder Java per le metriche client gRPC.

C++

Per disattivare le metriche lato client per l'API gRPC utilizzando le librerie client di Cloud per C++, consulta Struct EnableGrpcMetricsOption.

Se utilizzi Bazel per creare l'applicazione e vuoi disattivare le metriche lato client, imposta l'opzione enable_grpc_metrics su false nel file di build dell'applicazione.