Utilizzare le metriche lato client di gRPC

Questa pagina descrive come emettere metriche lato client gRPC in 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 differisce dalle metriche lato server, che forniscono informazioni sul rendimento di Cloud Storage dal punto di vista del server.

Come funziona

Puoi attivare l'emissione di metriche lato client in 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 maggiori informazioni sui prezzi, consulta la pagina 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 connettori di Cloud Storage supportano gRPC:

  2. Configura l'autenticazione.

  3. Abilita l'API Cloud Monitoring.

  4. Attiva l'API Cloud Storage.

    Vai all'API Cloud Storage

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

Ruoli obbligatori

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

Questo ruolo predefinito contiene le autorizzazioni necessarie per emettere metriche lato client gRPC in 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 ulteriori informazioni sul ruolo Scrittore metriche Monitoring, consulta la documentazione IAM su roles/monitoring.metricWriter.

Descrizioni delle metriche

Le seguenti sezioni 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 dei singoli tentativi effettuati da un client per comunicare con un server. Le metriche per tentativo del client possono aiutarti a misurare il comportamento di ripetizione, 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 di 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 canonico 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 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 del resolver passato dal criterio weighted_target o sulla stringa vuota se l'attributo del resolver non è impostato.
storage.googleapis.com/client/grpc/client/attempt/sent_total_compressed_message_size Preview. Il totale dei byte, compressi ma non criptati, che vengono inviati in tutti i messaggi di richiesta, ad eccezione dei metadati per tentativo RPC. Non sono inclusi i byte di framing di gRPC o di trasporto. Istogramma By
  • grpc.method: nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo.
  • grpc.target: URI di destinazione 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 del resolver passato dalla policy weighted_target o sulla stringa vuota se l'attributo del resolver non è impostato.
storage.googleapis.com/client/grpc/client/attempt/rcvd_total_compressed_message_size Preview. Il numero totale di byte, 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 di gRPC o di trasporto. Istogramma By
  • grpc.method: nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo.
  • grpc.target: URI di destinazione 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 del resolver trasmesso dal criterio weighted_target o sulla stringa vuota se l'attributo del resolver non è impostato.

Per maggiori informazioni sugli strumenti per tentativo del client, consulta la documentazione sulle metriche 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, forniscono metriche di monitoraggio per comprendere i pattern di chiamata e 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 una 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 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 maggiori informazioni sugli strumenti per chiamata per client, consulta la documentazione sulle metriche OpenTelemetry su GitHub.

Metriche di rilevamento del carico delle richieste

Le seguenti metriche forniscono informazioni sull'efficacia dell'utilizzo del rilevamento del carico delle richieste da parte dell'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 del 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 di richieste. Misuratore {entry}
  • grpc.target: indica la destinazione del canale gRPC in cui viene utilizzato WRR.
  • grpc.lb.rls.server_target: l'URI di destinazione a cui comunica il server di rilevamento del carico delle richieste.
  • grpc.lb.rls.instance_uuid: un identificatore univoco (UUID) per una singola istanza client di rilevamento del carico delle richieste. Il valore non è significativo di per sé, ma è utile per distinguere 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 la stessa destinazione.
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 a cui comunica il server di rilevamento del carico delle richieste.
  • grpc.lb.rls.instance_uuid: un UUID per una singola istanza client di rilevamento del carico delle richieste. Il valore non è significativo di per sé, ma è utile per distinguere 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 la stessa destinazione.
storage.googleapis.com/client/grpc/lb/rls/default_target_picks Preview. Il numero di selezioni 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 di destinazione utilizzata dal rilevamento del carico delle richieste per il traffico del data plane di routing. 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 selezione LB, ad esempio "complete", "fail" o "drop".
storage.googleapis.com/client/grpc/lb/rls/target_picks Preview. Il numero di scelte del bilanciamento del carico inviate a ogni target di rilevamento del carico delle richieste. Se il target predefinito viene restituito anche dal server di rilevamento del carico delle richieste, gli RPC inviati a questo target dalla cache vengono conteggiati 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 di destinazione utilizzata dal rilevamento del carico delle richieste per il traffico del data plane di routing. 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 selezione LB, ad esempio "complete", "fail" o "drop".
storage.googleapis.com/client/grpc/lb/rls/failed_picks Preview. Il numero di scelte di bilanciamento del carico non riuscite a causa di una richiesta di rilevamento del carico non riuscita o della limitazione del canale di rilevamento del carico. 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 piano di controllo del servizio xDiscovery (xDS) per scoprire 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 complessive di xDS.

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 un flusso ADS funzionante verso il server xDS. Per un determinato server, questa metrica è impostata su 1 quando lo stream viene creato inizialmente. Se si verifica un errore di connettività o quando il flusso ADS non va a buon fine senza visualizzare un messaggio di risposta come 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 in 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 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 che non sono più disponibili, sono 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, questa è la stringa "#server".

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

Disattivare le metriche lato client

Se necessario, puoi disattivare le metriche lato client.

Java

public GrpcStorageOptions.Builder setEnableGrpcClientMetrics(false enableGrpcClientMetrics)

Per ulteriori informazioni, consulta il metodo GrpcStorageOptions.Builder della classe Cloud Client Libraries for 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 la tua applicazione e vuoi disattivare le metriche lato client, imposta l'opzione enable_grpc_metrics su false nel file di build dell'applicazione.