Informazioni di riferimento sull'osservabilità dei microservizi

Dati di configurazione

I dati di configurazione trovati nelle variabili di ambiente sono definiti nella tabella seguente.

export GRPC_GCP_OBSERVABILITY_CONFIG='{
    "project_id": "your-project-here",
    "cloud_monitoring": {
    }
}'

export GRPC_GCP_OBSERVABILITY_CONFIG='{
    "project_id": "your-project-here",
    "cloud_trace": {
    }
}'

Definizioni Trace

Questa sezione fornisce informazioni sul monitoraggio.

Propagazione del contesto della traccia

Affinché il monitoraggio tra servizi funzioni, il proprietario del servizio deve supportare la propagazione del contesto della traccia ricevuto dall'upstream (o avviato autonomamente) al downstream. Il contesto Trace viene propagato tra i servizi tramite i metadati gRPC. Assicurati di abilitare le API Cloud Monitoring, Cloud Logging, Cloud Trace e Microservices, che consentono ai servizi in questa configurazione di segnalare i dati di telemetria al servizio appropriato.

Senza il supporto della propagazione, i servizi a valle non possono generare span per una traccia. Gli intervalli esistenti non sono interessati. I plug-in di osservabilità dei microservizi supportano il formato binario OpenCensus per la codifica e il contesto della traccia di codifica.

Intervalli

Il nome di un intervallo è formattato come segue:

Etichette di intervallo

Le integrazioni forniscono etichette di intervallo diverse.

Per gli intervalli di tentativi, vengono aggiunti altri due attributi correlati ai tentativi di ripetizione (etichette di intervallo):

Definizioni delle metriche

Le seguenti metriche sono disponibili e vengono visualizzate in una dashboard denominata Monitoraggio dei microservizi (gRPC) per i percorsi utente comuni.

Di seguito sono riportate le metriche lato client gRPC:

Sono disponibili le seguenti metriche lato server gRPC:

Ogni distribuzione nella tabella sopra contiene un istogramma con bucket come segue:

• Dimensioni in byte: 0, 1024, 2048, 4096, 16384, 65536, 262144, 1048576, 4194304, 16777216, 67108864, 268435456, 1073741824, 4294967296

• Latenza in ms: 0, 0,01, 0,05, 0,1, 0,3, 0,6, 0,8, 1, 2, 3, 4, 5, 6, 8, 10, 13, 16, 20, 25, 30, 40, 50, 65, 80, 100, 130, 160, 200, 250, 300, 400, 500, 650, 800, 1000, 2000, 5000, 10000, 20000, 50000, 100000

Descrizione del tag:

• grpc_client_method: nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo, ad esempio google.bigtable.v2.Bigtable/CheckAndMutateRow
• grpc_client_status: codice di stato del server gRPC ricevuto, ad esempio OK, CANCELLED, DEADLINE_EXCEEDED
• grpc_server_method: nome completo del metodo gRPC, inclusi pacchetto, servizio e metodo, ad esempio com.exampleapi.v4.BookshelfService/Checkout
• grpc_server_status: codice di stato del server gRPC restituito, ad esempio OK, CANCELLED, DEADLINE_EXCEEDED

Definizioni dei record dei log

I log di osservabilità dei microservizi vengono caricati in Cloud Logging utilizzando il nome del log (PROJECT_ID è il segnaposto per la stringa che rappresenta il tuo progetto):

logName=projects/[PROJECT_ID]/logs/microservices.googleapis.com%2Fobservability%2Fgrpc

Di seguito è riportata la rappresentazione JSON del record del log generato:

{
    "authority": string,
    "callId": string,
    "type": string,
    "logger": string,
    "serviceName": string,
    "methodName": string,
    "peer": {
        "type": string,
        "address": string,
        "ipPort": int
    },
    "payload": {
        "timeout": string,
        "metadata":
            {
                string: string,
                string: string
            },
        "statusCode": string,
        "statusMessage": string,
        "statusDetails": string,
        "message": string,
        "messageLength": int,
    },
    "sequenceId": int
}

La tabella seguente descrive i campi della voce di log:

Etichette risorse

Le etichette delle risorse identificano l'origine che genera i dati di osservabilità. Ogni etichetta della risorsa è una coppia chiave-valore, in cui le chiavi sono valori predefiniti specifici per l'ambiente di origine (ad esempio GKE o Compute Engine).

Per le metriche e il monitoraggio nei deployment GKE, le etichette delle risorse vengono compilate per impostazione predefinita, ad eccezione del nome del contenitore e del nome dello spazio dei nomi. I valori mancanti possono essere inseriti utilizzando l'API Downward.

Di seguito sono riportate le chiavi variabile di ambiente:

• CONTAINER_NAME
• NAMESPACE

Ad esempio, la sezione env riportata di seguito include due etichette delle risorse:

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    run: app1
  name: app1
spec:
  replicas: 2
  selector:
    matchLabels:
      run: app1
  template:
    metadata:
      labels:
        run: app1
    spec:
      containers:
        - image: 'o11y-examples:1.00'
          name: container1
          ports:
            - protocol: TCP
              containerPort: 50051
          env:
            - name: CONTAINER_NAME
              value: container1
            - name: NAMESPACE
              valueFrom:
                fieldRef:
                  fieldPath: metadata.namespace

Etichette personalizzate

Le etichette personalizzate rappresentano informazioni aggiuntive fornite dall'utente nei dati di osservabilità. Le etichette sono costituite da una chiave e un valore. La coppia chiave-valore viene associata ai dati di monitoraggio come etichette di intervallo, ai dati delle metriche come etichette delle metriche e ai dati di logging come etichette di voce di log. Tutte le etichette personalizzate sono di tipo STRING.

Puoi fornire etichette personalizzate nella configurazione specificando un elenco di coppie chiave-valore per labels. L'implementazione legge la configurazione e crea un'etichetta separata per ogni coppia chiave/valore, quindi la associa ai dati di osservabilità. Ad esempio:

"labels": {
    "DATACENTER": "SAN_JOSE_DC",
    "APP_ID": "24512"
  }

Ogni voce di log contiene le seguenti etichette aggiuntive:

{
   "DATACENTER": "SAN_JOSE_DC"
   "APP_ID": "24512"
}

Passaggi successivi

• Per informazioni sui tipi e sui generi di metriche, consulta Tipi di valore e tipi di metriche.
• Per informazioni sulle distribuzioni, consulta la pagina di riferimento sulle distribuzioni.
• Per informazioni sulla visualizzazione delle metriche di distribuzione sotto forma di grafici, consulta Metriche di distribuzione.
• Per informazioni sulle unità (ad es. 1, ms e By), consulta il campo unit nel riferimento MetricDescriptor.