Osservabilità con applicazioni gRPC senza proxy
Gli strumenti di osservabilità dei microservizi offrono la possibilità di instrumentare le tue applicazioni per raccogliere e presentare dati di telemetria in Cloud Monitoring, Cloud Logging e Cloud Trace dai carichi di lavoro gRPC distribuiti su Google Cloud, inclusi i carichi di lavoro gRPC in Cloud Service Mesh.
I client e i server gRPC sono integrati con OpenCensus per esportare metriche e tracce su vari backend, tra cui Trace e Monitoring. Puoi farlo con i seguenti linguaggi gRPC:
- C++
- Go
- Java
Leggi la panoramica sull'osservabilità dei microservizi, quindi utilizza le istruzioni in Configurare l'osservabilità dei microservizi per instrumentare i carichi di lavoro gRPC per quanto segue:
- Cloud Monitoring e la visualizzazione delle metriche.
- Cloud Logging e visualizzazione dei log.
- Cloud Trace e la visualizzazione delle tracce.
Segui le istruzioni riportate in questo documento per le seguenti attività:
- Visualizzazione delle tracce.
- Presentazione dell'interfaccia di amministrazione.
- Utilizzo dello strumento
grpcdebug
e di altri strumenti per eseguire il debug delle applicazioni.
Visualizza tracce su Trace
Dopo aver completato il processo di configurazione, i client e i server gRPC instrumentati inviano tracce a Trace. La pagina Panoramica di Trace nella console Google Cloud mostra un elenco delle tracce recenti. Puoi selezionare una singola traccia per visualizzare un'analisi dettagliata del traffico, simile a quanto descritto nella sezione seguente.
Trace la compatibilità con il proxy Envoy
L'esportazione delle tracce in Trace con Cloud Service Mesh e il proxy Envoy, come descritto in Observability con Envoy, utilizza la configurazione del tracciamento OpenCensus di Envoy, che consente alle tracce esportate da applicazioni gRPC senza proxy e da proxy Envoy di essere completamente compatibili all'interno di un mesh di servizi. Per garantire la compatibilità con gRPC senza proxy, il bootstrap Envoy deve
configurare il contesto della traccia in modo da includere il formato di traccia GRPC_TRACE_BIN
nel suo OpenCensusConfig
. Ad esempio:
tracing: http: name: envoy.tracers.opencensus typed_config: "@type": type.googleapis.com/envoy.config.trace.v2.OpenCensusConfig stackdriver_exporter_enabled: "true" stackdriver_project_id: "PROJECT_ID" incoming_trace_context: ["CLOUD_TRACE_CONTEXT", "GRPC_TRACE_BIN"] outgoing_trace_context: ["CLOUD_TRACE_CONTEXT", "GRPC_TRACE_BIN"]
Esporre l'interfaccia di amministrazione
A volte, le metriche e i dati di tracciamento non sono sufficienti per risolvere un problema. Potrebbe essere necessario esaminare lo stato di configurazione o di runtime della libreria gRPC nell'applicazione. Queste includono informazioni sul resolver, lo stato della connettività ai peer, le statistiche RPC su un canale e la configurazione ricevuta da Cloud Service Mesh.
Per ottenere queste informazioni, le applicazioni gRPC possono esporre l'interfaccia di amministrazione su una porta Puoi quindi eseguire query sull'applicazione per capire come sono configurati i servizi e come vengono eseguiti. In questa sezione puoi trovare le istruzioni su come configurare l'interfaccia di amministrazione per le applicazioni scritte in tutte le lingue supportate.
Ti consigliamo di creare un server gRPC separato nell'applicazione
che ascolti su una porta riservata a questo scopo. Questo consente di accedere alle applicazioni gRPC anche quando le porte di dati sono inaccessibili a causa di problemi di configurazione o di rete. Ti consigliamo di esporre l'interfaccia di amministrazione
solo su localhost
o su un socket di dominio Unix.
I seguenti snippet di codice mostrano come creare un'interfaccia di amministrazione.
C++
In C++, utilizza questo codice per creare un'interfaccia di amministrazione:
#include <grpcpp/ext/admin_services.h> grpc::ServerBuilder builder; grpc::AddAdminServices(&builder); builder.AddListeningPort(":50051", grpc::ServerCredentials(...)); std::unique_ptr<grpc::Server> server(builder.BuildAndStart());
Go
In Go, utilizza questo codice per creare un'interfaccia di amministrazione:
import "google.golang.org/grpc/admin" lis, err := net.Listen("tcp", ":50051") if err != nil { log.Fatalf("failed to listen: %v", err) } defer lis.Close() grpcServer := grpc.NewServer(...opts) cleanup, err := admin.Register(grpcServer) if err != nil { log.Fatalf("failed to register admin services: %v", err) } defer cleanup() if err := grpcServer.Serve(lis); err != nil { log.Fatalf("failed to serve: %v", err) }
Java
In Java, utilizza questo codice per creare un'interfaccia di amministrazione:
import io.grpc.services.AdminInterface; server = ServerBuilder.forPort(50051) .useTransportSecurity(certChainFile, privateKeyFile) .addServices(AdminInterface.getStandardServices()) .build() .start(); server.awaitTermination();
Python
In Python, utilizza questo codice per creare un'interfaccia di amministrazione:
import grpc_admin server = grpc.server(futures.ThreadPoolExecutor()) grpc_admin.add_admin_servicers(server) server.add_insecure_port('[::]:50051') server.start() server.wait_for_termination()
Utilizza SSH per connetterti a una VM
L'esempio gRPC Wallet attiva già l'interfaccia di amministrazione. Puoi modificare la porta dell'interfaccia di amministrazione fornendo il seguente flag:
--admin-port=PORT
La porta di amministrazione predefinita è localhost:28881
.
Per eseguire il debug dell'applicazione gRPC, puoi utilizzare SSH per connetterti a una delle VM che gestisce wallet-service
. In questo modo potrai accedere all'localhost
.
# List the Wallet VMs $ gcloud compute instances list --filter="zone:(us-central1-a)" --filter="name~'grpcwallet-wallet-v2'" NAME ZONE MACHINE_TYPE PREEMPTIBLE INTERNAL_IP EXTERNAL_IP STATUS grpcwallet-wallet-v2-mig-us-central1-ccl1 us-central1-a n1-standard-1 10.240.0.38 35.223.42.98 RUNNING grpcwallet-wallet-v2-mig-us-central1-k623 us-central1-a n1-standard-1 10.240.0.112 35.188.133.75 RUNNING # Pick one of the Wallet VMs to debug $ gcloud compute ssh grpcwallet-wallet-v2-mig-us-central1-ccl1 --zone=us-central1-a
Installa lo strumento grpcdebug
Per accedere all'interfaccia di amministrazione, è necessario un client gRPC in grado di comunicare con
i servizi di amministrazione nell'applicazione gRPC. Negli esempi seguenti viene utilizzato uno strumento denominato grpcdebug
che puoi scaricare e installare sulla VM o sul pod in cui è in esecuzione la tua applicazione gRPC. Il repository per grpcdebug
si trova in
grpc-ecosystem/grpcdebug.
La versione minima di Golang è la 1.12. La guida ufficiale all'installazione di Golang è disponibile sul sito di Golang.
Se stai seguendo la guida per creare una VM Linux per wallet-service
, puoi installare Golang 1.16 utilizzando questi comandi:
sudo apt update && sudo apt install -y wget wget https://golang.org/dl/go1.16.3.linux-amd64.tar.gz sudo rm -rf /usr/local/go sudo tar -C /usr/local -xzf go1.16.3.linux-amd64.tar.gz export PATH=$PATH:/usr/local/go/bin sudo ln -sf /usr/local/go/bin/go /usr/bin/go go version # go version go1.16.3 linux/amd64
Puoi installare lo strumento grpcdebug
con i seguenti comandi:
go install -v github.com/grpc-ecosystem/grpcdebug@latest export PATH=$PATH:$(go env GOPATH)/bin
Ora hai accesso all'interfaccia a riga di comando grpcdebug
. L'output della guida contiene informazioni sui comandi supportati:
$ grpcdebug -h grpcdebug is a gRPC service admin command-line interface Usage: grpcdebug <target address> [flags] <command> Available Commands: channelz Display gRPC states in human readable way. health Check health status of the target service (default ""). help Help about any command xds Fetch xDS related information. Flags: --credential_file string Sets the path of the credential file; used in [tls] mode -h, --help Help for grpcdebug --security string Defines the type of credentials to use [tls, google-default, insecure] (default "insecure") --server_name_override string Overrides the peer server name if non empty; used in [tls] mode -t, --timestamp Print timestamp as RFC 3339 instead of human readable strings -v, --verbose Print verbose information for debugging
Per ottenere maggiori informazioni su un determinato comando, utilizza il seguente comando:
grpcdebug <target address> [command] --help
Usa lo strumento grpcdebug
per eseguire il debug delle tue applicazioni
Puoi utilizzare lo strumento grpcdebug
per eseguire il debug delle tue applicazioni.
Lo strumento grpcdebug
fornisce una configurazione di tipo ssh_config
che supporta
alias, riscrittura del nome host e impostazioni di sicurezza della connessione (non sicuro/TLS).
Per maggiori informazioni su questa funzionalità avanzata, consulta
grpcdebug/Connect&Security
.
Le seguenti sezioni descrivono i servizi esposti dall'interfaccia di amministrazione e come accedervi.
Utilizzare Channelz
Il servizio Channelz consente di accedere alle informazioni di runtime relative alle connessioni a diversi livelli nella libreria gRPC della tua applicazione. Puoi utilizzarla per eseguire l'analisi in tempo reale delle applicazioni che potrebbero presentare problemi relativi alla configurazione o alla rete. Gli esempi seguenti presuppongono che tu abbia eseguito il deployment dell'esempio di gRPC Wallet utilizzando le istruzioni in Configurare la gestione avanzata del traffico con servizi gRPC senza proxy e che tu abbia fornito il flag seguente:
--admin-port=PORT
Dopo aver inviato alcune RPC da un client di test, come mostrato in Verifica della configurazione, utilizza i seguenti comandi per accedere ai dati Channelz per i servizi gRPC:
- Utilizza SSH per connetterti a una VM che esegue
wallet-service
. - Configura
grpcdebug
per connetterti all'applicazione gRPC in esecuzione.
L'output predefinito di grpcdebug
è in un formato di tabella compatibile con la console. Se fornisci il flag --json
, l'output viene codificato come JSON
.
Il comando grpcdebug channelz
viene utilizzato per recuperare e presentare le informazioni di debug dal servizio Channelz. Il comando funziona sia per i client
gRPC sia per i server gRPC.
Per i client gRPC, il comando grpcdebug channelz channels
fornisce un elenco dei canali esistenti e alcune informazioni di base:
$ grpcdebug localhost:28881 channelz channels Channel ID Target State Calls(Started/Succeeded/Failed) Created Time 1 xds:///account.grpcwallet.io:10080 READY 0/0/0 59 seconds ago 2 trafficdirector.googleapis.com:443 READY 2/0/0 59 seconds ago 4 xds:///stats.grpcwallet.io:10080 READY 0/0/0 59 seconds ago
Se hai bisogno di ulteriori informazioni su un determinato canale, puoi utilizzare grpcdebug channelz channel [CHANNEL_ID]
per esaminare informazioni dettagliate su quel canale. L'identificatore di canale può essere l'ID canale o
l'indirizzo di destinazione, se c'è un solo indirizzo di destinazione. Un canale gRPC può contenere più sottocanali, ovvero l'astrazione di gRPC in cima a una connessione TCP.
$ grpcdebug localhost:28881 channelz channel 2 Channel ID: 2 Target: trafficdirector.googleapis.com:443 State: READY Calls Started: 2 Calls Succeeded: 0 Calls Failed: 0 Created Time: 10 minutes ago --- Subchannel ID Target State Calls(Started/Succeeded/Failed) CreatedTime 3 trafficdirector.googleapis.com:443 READY 2/0/0 10 minutes ago --- Severity Time Child Ref Description CT_INFO 10 minutes ago Channel Created CT_INFO 10 minutes ago parsed scheme: "" CT_INFO 10 minutes ago scheme "" not registered, fallback to default scheme CT_INFO 10 minutes ago ccResolverWrapper: sending update to cc: {[{trafficdirector.googleapis.com:443 <nil> 0 <nil>}] <nil> <nil>} CT_INFO 10 minutes ago Resolver state updated: {Addresses:[{Addr:trafficdirector.googleapis.com:443 ServerName: Attributes:<nil> Type:0 Metadata:<nil>}] ServiceConfig:<nil> Attributes:<nil>} (resolver returned new addresses) CT_INFO 10 minutes ago ClientConn switching balancer to "pick_first" CT_INFO 10 minutes ago Channel switches to new LB policy "pick_first" CT_INFO 10 minutes ago subchannel(subchannel_id:3 ) Subchannel(id:3) created CT_INFO 10 minutes ago Channel Connectivity change to CONNECTING CT_INFO 10 minutes ago Channel Connectivity change to READY
Puoi anche esaminare le informazioni dettagliate relative a un canale secondario:
$ grpcdebug localhost:28881 channelz subchannel 3 Subchannel ID: 3 Target: trafficdirector.googleapis.com:443 State: READY Calls Started: 2 Calls Succeeded: 0 Calls Failed: 0 Created Time: 12 minutes ago --- Socket ID Local->Remote Streams(Started/Succeeded/Failed) Messages(Sent/Received) 9 10.240.0.38:60338->142.250.125.95:443 2/0/0 214/132
Puoi recuperare le informazioni sui socket TCP:
$ grpcdebug localhost:28881 channelz socket 9 Socket ID: 9 Address: 10.240.0.38:60338->142.250.125.95:443 Streams Started: 2 Streams Succeeded: 0 Streams Failed: 0 Messages Sent: 226 Messages Received: 141 Keep Alives Sent: 0 Last Local Stream Created: 12 minutes ago Last Remote Stream Created: a long while ago Last Message Sent Created: 8 seconds ago Last Message Received Created: 8 seconds ago Local Flow Control Window: 65535 Remote Flow Control Window: 966515 --- Socket Options Name Value SO_LINGER [type.googleapis.com/grpc.channelz.v1.SocketOptionLinger]:{duration:{}} SO_RCVTIMEO [type.googleapis.com/grpc.channelz.v1.SocketOptionTimeout]:{duration:{}} SO_SNDTIMEO [type.googleapis.com/grpc.channelz.v1.SocketOptionTimeout]:{duration:{}} TCP_INFO [type.googleapis.com/grpc.channelz.v1.SocketOptionTcpInfo]:{tcpi_state:1 tcpi_options:7 tcpi_rto:204000 tcpi_ato:40000 tcpi_snd_mss:1408 tcpi_rcv_mss:1408 tcpi_last_data_sent:8212 tcpi_last_data_recv:8212 tcpi_last_ack_recv:8212 tcpi_pmtu:1460 tcpi_rcv_ssthresh:88288 tcpi_rtt:2400 tcpi_rttvar:3012 tcpi_snd_ssthresh:2147483647 tcpi_snd_cwnd:10 tcpi_advmss:1408 tcpi_reordering:3} --- Security Model: TLS Standard Name: TLS_AES_128_GCM_SHA256
Sul lato server, puoi utilizzare Channelz per esaminare lo stato dell'applicazione server. Ad esempio, puoi ottenere l'elenco dei server utilizzando il comando grpcdebug
channelz servers
:
$ grpcdebug localhost:28881 channelz servers Server ID Listen Addresses Calls(Started/Succeeded/Failed) Last Call Started 5 [127.0.0.1:28881] 9/8/0 now 6 [[::]:50051] 159/159/0 4 seconds ago
Per ottenere maggiori informazioni su un server specifico, utilizza il comando grpcdebug channelz
server
. Puoi controllare i socket dei server nello stesso modo in cui ispezioni i socket client.
$ grpcdebug localhost:28881 channelz server 6 Server Id: 6 Listen Addresses: [[::]:50051] Calls Started: 174 Calls Succeeded: 174 Calls Failed: 0 Last Call Started: now --- Socket ID Local->Remote Streams(Started/Succeeded/Failed) Messages(Sent/Received) 25 10.240.0.38:50051->130.211.1.39:44904 68/68/0 68/68 26 10.240.0.38:50051->130.211.0.167:32768 54/54/0 54/54 27 10.240.0.38:50051->130.211.0.22:32768 52/52/0 52/52
Utilizzare il servizio di rilevamento dello stato del client
L'API Client Status Discovery Service (CSDS) fa parte delle API xDS. In un'applicazione gRPC, il servizio CSDS fornisce l'accesso alla configurazione (detta anche configurazione xDS) che riceve da Cloud Service Mesh. In questo modo puoi identificare e risolvere i problemi relativi alla configurazione nel mesh.
I seguenti esempi presuppongono che tu abbia eseguito il deployment dell'esempio di Wallet gRPC utilizzando le istruzioni in Configurare la gestione avanzata del traffico con i servizi gRPC senza proxy.
Per utilizzare la crittografia lato client per esaminare la configurazione:
- Utilizza SSH per connetterti a una VM che esegue
wallet-service
. Segui le istruzioni in Utilizzare SSH per connettersi a una VM. - Esegui il client
grpcdebug
.
Per una panoramica dello stato della configurazione, esegui questo comando:
grpcdebug localhost:28881 xds status
Vedrai risultati simili ai seguenti:
Name Status Version Type LastUpdated account.grpcwallet.io:10080 ACKED 1618529574783547920 type.googleapis.com/envoy.config.listener.v3.Listener 3 seconds ago stats.grpcwallet.io:10080 ACKED 1618529574783547920 type.googleapis.com/envoy.config.listener.v3.Listener 3 seconds ago URL_MAP/830293263384_grpcwallet-url-map_0_account.grpcwallet.io:10080 ACKED 1618529574783547920 type.googleapis.com/envoy.config.route.v3.RouteConfiguration 3 seconds ago URL_MAP/830293263384_grpcwallet-url-map_1_stats.grpcwallet.io:10080 ACKED 1618529574783547920 type.googleapis.com/envoy.config.route.v3.RouteConfiguration 3 seconds ago cloud-internal-istio:cloud_mp_830293263384_3566964729007423588 ACKED 1618529574783547920 type.googleapis.com/envoy.config.cluster.v3.Cluster 3 seconds ago cloud-internal-istio:cloud_mp_830293263384_7383783194368524341 ACKED 1618529574783547920 type.googleapis.com/envoy.config.cluster.v3.Cluster 3 seconds ago cloud-internal-istio:cloud_mp_830293263384_3363366193797120473 ACKED 1618529574783547920 type.googleapis.com/envoy.config.cluster.v3.Cluster 3 seconds ago cloud-internal-istio:cloud_mp_830293263384_3566964729007423588 ACKED 86 type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment 2 seconds ago cloud-internal-istio:cloud_mp_830293263384_3363366193797120473 ACKED 86 type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment 2 seconds ago cloud-internal-istio:cloud_mp_830293263384_7383783194368524341 ACKED 86 type.googleapis.com/envoy.config.endpoint.v3.ClusterLoadAssignment 2 seconds ago
La definizione dello stato di configurazione è disponibile nella
documentazione per il proxy Envoy.
In breve, lo stato di una risorsa xDS è REQUESTED
, DOES_NOT_EXIST
,
ACKED
o NACKED
.
Per ottenere un dump della configurazione xDS non elaborata, esegui questo comando:
grpcdebug localhost:28881 xds config
Viene visualizzato un elenco JSON
dell'oggetto PerXdsConfig
:
{ "config": [ { "node": { "id": "projects/830293263384/networks/default/nodes/6e98b038-6d75-4a4c-8d35-b0c7a8c9cdde", "cluster": "cluster", "metadata": { "INSTANCE_IP": "10.240.0.38", "TRAFFICDIRECTOR_GCP_PROJECT_NUMBER": "830293263384", "TRAFFICDIRECTOR_NETWORK_NAME": "default" }, "locality": { "zone": "us-central1-a" }, "userAgentName": "gRPC Go", "userAgentVersion": "1.37.0", "clientFeatures": [ "envoy.lb.does_not_support_overprovisioning" ] }, "xdsConfig": [ { "listenerConfig": { "versionInfo": "1618529930989701137", "dynamicListeners": [ { ...
Se l'output della configurazione non elaborata è troppo dettagliato, grpcdebug
ti consente di filtrare
in base a tipi xDS specifici. Ad esempio:
$ grpcdebug localhost:28881 xds config --type=cds { "versionInfo": "1618530076226619310", "dynamicActiveClusters": [ { "versionInfo": "1618530076226619310", "cluster": { "@type": "type.googleapis.com/envoy.config.cluster.v3.Cluster", "name": "cloud-internal-istio:cloud_mp_830293263384_7383783194368524341", "altStatName": "/projects/830293263384/global/backendServices/grpcwallet-stats-service", "type": "EDS", "edsClusterConfig": { "edsConfig": { "ads": {}, "initialFetchTimeout": "15s", ...
Puoi anche eseguire il dump della configurazione dei tipi xDS Seberal:
$ grpcdebug localhost:28881 xds config --type=lds,eds { "versionInfo": "1618530076226619310", "dynamicListeners": [...] } { "dynamicEndpointConfigs": [...] }
Passaggi successivi
- Per trovare informazioni correlate, consulta Observability con Envoy.
- Per risolvere i problemi di configurazione quando esegui il deployment di servizi gRPC senza proxy, consulta Risoluzione dei problemi dei deployment che utilizzano gRPC senza proxy.