Instrumentare un'applicazione per il monitoraggio delle applicazioni

Questo documento descrive come configurare un'applicazione App Hub in modo che le metriche e i dati di traccia generati dall'applicazione contengano etichette specifiche dell'applicazione. Descrive inoltre come fare in modo che l'applicazione esporti una metrica utilizzata da Application Monitoring per segnalare il livello di traffico, il tasso di errori del server o la latenza per i carichi di lavoro delle richieste HTTP eseguiti su Google Kubernetes Engine.

Informazioni sulle etichette specifiche dell'applicazione

Le etichette specifiche per l'applicazione si riferiscono a etichette o attributi inseriti nei dati di log, metriche o traccia. Queste etichette identificano il servizio o il workload che ha generato i dati. Puoi utilizzare le etichette specifiche dell'applicazione come qualsiasi altra etichetta. Ad esempio, puoi filtrare i dati in base all'ID di un'applicazione. La telemetria generata dall'infrastruttura supportata include automaticamente queste etichette. Con la strumentazione, le metriche e le tracce scritte dalla tua applicazione possono includere queste etichette.

In questa sezione, interpreta a.b.{x,y} come a.b.x e a.b.y.

I dati delle metriche provenienti dalla strumentazione che hai aggiunto alle tue applicazioni possono includere le seguenti etichette delle metriche:

• metric.labels.apphub_application_{container,id,location}
• metric.labels.apphub_workload_{criticality_type,environment_type,id}

Gli intervalli di Trace generati dalla strumentazione aggiunta alle tue applicazioni possono includere i seguenti attributi delle risorse:

• gcp.apphub.application.{container,id,location}
• gcp.apphub.{workload,service}.{criticality_type,environment_type,id}

Informazioni sulle metriche del server HTTP OpenTelemetry

Non esistono metriche di sistema per i carichi di lavoro eseguiti su Google Kubernetes Engine che possono segnalare il livello di traffico, il tasso di errori del server o la latenza per le richieste HTTP. Tuttavia, i valori di questi indicatori chiave possono essere derivati da http.server.request.duration, una metrica raccolta automaticamente dalla libreria client HTTP OpenTelemetry.

L'esportatore googlemanagedprometheus converte la metrica OpenTelemetry http.server.request.duration in una metrica Prometheus con le seguenti proprietà:

• Nome: prometheus/http_server_request_duration_seconds/histogram
• Metrica: prometheus.googleapis.com/http_server_request_duration_seconds/histogram
• Tipi di risorse: prometheus_target
• Unità: s
• Tipo: CUMULATIVE
• Tipo di valore: DISTRIBUTION

Quando il tuo progetto Google Cloud contiene la metrica http_server_request_duration_seconds, le dashboard di Application Monitoring mostrano il livello di traffico, il tasso di errori del server e la latenza per le richieste HTTP.

Per scoprire come configurare l'applicazione per esportare la metrica http_server_request_duration_seconds, consulta la sezione Utilizzare OpenTelemetry su Kubernetes di questo documento.

Aggiungere etichette dell'applicazione ai dati delle metriche

Google Cloud Observability tenta di identificare l'origine delle metriche Prometheus confrontando gli attributi allegati alle metriche Prometheus inviate al tuo progetto con i dati restituiti dall'API App Hub. Il resto di questa sezione elenca le configurazioni che consentono a Google Cloud Observability di identificare l'applicazione App Hub.

Utilizzare OpenTelemetry su Kubernetes

Nota: ti consigliamo di utilizzare questo approccio con il raccoglitore OpenTelemetry integrato in Google. Se esegui carichi di lavoro su Google Kubernetes Engine, questo approccio esporta la metrica del server HTTP che Application Monitoring utilizza per generare valori per il livello di traffico, il tasso di errori del server e la latenza per le richieste HTTP.

Per fare in modo che Google Cloud Observability associ le etichette dell'applicazione ai dati delle metriche generati dai carichi di lavoro dell'applicazione eseguiti in Google Kubernetes Engine, procedi nel seguente modo:

1. Instrumenta l'applicazione con OpenTelemetry.

   • Per informazioni generali, consulta Instrumentazione e osservabilità.
   • Per i link agli esempi di Go, Java, Node.js e Python, nonché informazioni su questi esempi, consulta Panoramica degli esempi di strumentazione.

2. Esegui il deployment del raccoglitore creato da Google o del raccoglitore OpenTelemetry e configura il raccoglitore nel seguente modo:

   • Esporta i dati delle metriche con l'esportatore googlemanagedprometheus.
   • Configura il processore k8sattributes per estrarre i metadati, come namespace, dall'ambiente.
   • Configura il processore transform/collision per impostare gli attributi project_id, location, cluster e namespace.
   • Configura il processore transform/aco-gke per compilare le etichette top_level_controller_name e top_level_controller_type.

   Per un esempio, vedi otlp-k8s-ingest/config/collector.yaml, che è il file di configurazione per Collector creato da Google. Per saperne di più su questo raccoglitore, consulta Deploy di Google-Built OpenTelemetry Collector su GKE.

3. Registra i workload della tua applicazione con App Hub.

Utilizzare Google Cloud Managed Service per Prometheus su GKE

Per fare in modo che Google Cloud Observability colleghi le etichette delle applicazioni ai dati delle metriche generati dai carichi di lavoro dell'applicazione in esecuzione sui cluster Google Kubernetes Engine, procedi nel seguente modo:

1. Utilizza Google Cloud Managed Service per Prometheus con la raccolta gestita.

2. Esegui il deployment dei carichi di lavoro su un cluster Google Kubernetes Engine la cui versione sia almeno 1.32.1-gke.1439000.

3. Registra i workload della tua applicazione con App Hub.

Google Cloud Managed Service per Prometheus rileva i valori delle etichette dell'applicazione tramite i metadati di service discovery e poi aggiunge le etichette top_level_controller_{name,type} all'targetLabels.metadata. Durante l'importazione delle metriche, Google Cloud Observability utilizza le etichette top_level_controller_{name,type} e l'API App Hub per identificare l'applicazione App Hub e aggiungere le etichette appropriate ai dati delle metriche.

Utilizzare Cloud Run

Per fare in modo che Google Cloud Observability colleghi le etichette dell'applicazione ai dati delle metriche generati dai carichi di lavoro Cloud Run, procedi nel seguente modo:

1. Strumenta la tua applicazione utilizzando OpenTelemetry o il file collaterale Managed Service per Prometheus per Cloud Run. Per informazioni su questi approcci, consulta i seguenti documenti:

   • Esegui il deployment del raccoglitore OpenTelemetry creato da Google su Cloud Run
   • Utilizza il file collaterale Prometheus per Cloud Run

2. Registra i workload della tua applicazione con App Hub.

Verificare le etichette delle metriche

Per verificare che la tua applicazione invii le metriche Prometheus al tuo progetto, segui questi passaggi:

1. Verifica che la tua applicazione invii le metriche Prometheus al tuo progetto:

   1. Nella console Google Cloud , vai alla pagina  Esplora metriche:

      Vai a Esplora metriche

      Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

   2. Nella barra degli strumenti della console Google Cloud , seleziona il tuo progetto Google Cloud . Per le configurazioni di App Hub, seleziona il progetto host di App Hub o il progetto di gestione della cartella app.
   3. Nell'elemento Metrica, espandi il menu Seleziona una metrica, digita Prometheus Target nella barra dei filtri e poi utilizza i sottomenu per selezionare un tipo di risorsa e una metrica specifici:
      1. Nel menu Risorse attive, seleziona Target Prometheus.
      2. Per selezionare una metrica, utilizza i menu Categorie di metriche attive e Metriche attive.
      3. Fai clic su Applica.

   4. Per aggiungere filtri, che rimuovono le serie temporali dai risultati della query, utilizza l'elemento Filtro.

   5. Configura la modalità di visualizzazione dei dati.
      

      Per visualizzare le etichette, espandi il menu Filtro. Ogni voce nel Filtro corrisponde a un'etichetta.

      Per ulteriori informazioni sulla configurazione di un grafico, consulta Seleziona le metriche durante l'utilizzo di Esplora metriche.

   Se non visualizzi alcuna metrica Prometheus, rivedi la configurazione.

Se le metriche Prometheus non contengono etichette dell'applicazione, segui questi passaggi:

1. Verifica di aver registrato il workload o il servizio con App Hub.

2. Esamina i log per determinare se sono presenti errori.

   Ad esempio, se esegui il deployment di un collettore OpenTelemetry o del collettore creato da Google e utilizzi Google Kubernetes Engine, puoi procedere nel seguente modo:

   1. Nella console Google Cloud , vai alla pagina Workload:

      Vai a Carichi di lavoro

      Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Kubernetes Engine.

   2. Seleziona la distribuzione del raccoglitore, quindi seleziona la scheda Log.

3. Se utilizzi un OpenTelemetry Collector o il raccoglitore creato da Google, rivedi la configurazione del raccoglitore. Il raccoglitore deve:

   • Esporta i dati delle metriche con l'esportatore googlemanagedprometheus.
   • Configura il processore k8sattributes per estrarre i metadati, come namespace, dall'ambiente.
   • Configura il processore transform/collision per impostare gli attributi project_id, location, cluster e namespace.
   • Configura il processore transform/aco-gke per compilare le etichette top_level_controller_name e top_level_controller_type.

   Per un esempio, vedi il file di configurazione del raccoglitore creato da Google: otlp-k8s-ingest/config/collector.yaml.

Aggiungere attributi dell'applicazione agli span di traccia

Non strumentare l'applicazione in modo che gli attributi specifici dell'applicazione vengano allegati agli span inviati al tuo progetto Google Cloud . Google Cloud Observability utilizza invece gli attributi delle risorse OpenTelemetry e l'API App Hub per identificare l'applicazione App Hub associata a uno span, quindi aggiunge gli attributi specifici dell'applicazione prima di archiviare lo span.

Per fare in modo che Google Cloud Observability colleghi gli attributi delle risorse specifici dell'applicazione ai dati di traccia generati dai servizi e dai carichi di lavoro dell'applicazione, esegui tutte le seguenti operazioni:

• Instrumenta la tua applicazione con OpenTelemetry e configura l'esportatore per inviare i dati di traccia all'endpoint dell'API Telemetry (OTLP).

  Ti consigliamo un'esportazione basata sul raccoglitore. I seguenti documenti descrivono i raccoglitori che collegano tutti gli attributi richiesti ai dati di intervallo:

  • Esegui il deployment di Google-Built OpenTelemetry Collector su Google Kubernetes Engine.
  • Esegui il deployment del raccoglitore OpenTelemetry creato da Google su Cloud Run.
  • Esegui il deployment di OpenTelemetry Collector su Container-Optimized OS.

  Se non utilizzi uno dei raccoglitori precedenti, devi configurare la strumentazione o il raccoglitore in modo che alleghi tutti gli attributi richiesti.

• Esegui il deployment dei tuoi servizi e carichi di lavoro sull'infrastruttura supportata.

• Registra i tuoi servizi e workload con App Hub.

Per saperne di più su questi attributi, consulta le Google Cloud convenzioni semantiche di App Hub.

Attributi obbligatori

Nota :per le applicazioni di cui è stato eseguito il deployment in Google Kubernetes Engine, ti consigliamo di utilizzare Google-Built OpenTelemetry Collector.

Questa sezione si applica alle configurazioni in cui non utilizzi uno dei collettori consigliati. Ad esempio, potresti voler scrivere un tuo collettore o potresti preferire esportare direttamente i dati di traccia.

Attributi che identificano la posizione del progetto e della risorsa

Imposta i seguenti attributi:

• cloud.provider: impostato su "gcp".
• cloud.account.id: impostalo sull'ID progetto.
• cloud.availability_zone o cloud.region: impostato sulla zona o regione in cui si trovano le risorse. Puoi impostare entrambi gli attributi.

I rilevatori di risorse possono aiutarti a impostare gli attributi precedenti:

• resourcedetectionprocessor
• Vai a: Google Cloud strumento di rilevamento delle risorse
• Java: opentelemetry-java-contrib/gcp-resources
• Node.js: resource-detector-gcp
• Python: opentelemetry-resourcedetector-gcp

Attributi per i carichi di lavoro Google Kubernetes Engine

Per un carico di lavoro Google Kubernetes Engine, configura il raccoglitore o la strumentazione per eseguire le seguenti operazioni:

• Estrai i metadati, come namespace, dall'ambiente.
• Estrai i metadati pertinenti dal processore k8sattributes.
• Imposta gli attributi project_id, location, cluster e namespace.
• Imposta le etichette top_level_controller_name e top_level_controller_type.

Per un esempio basato sul raccoglitore, vedi otlp-k8s-ingest/config/collector.yaml. Questo raccoglitore utilizza il processore k8sattributesprocessor.

Attributi per i carichi di lavoro delle VM

Se esegui il deployment dell'applicazione su una VM, questa deve essere associata a un gruppo di istanze gestite (MIG). Devi anche allegare i seguenti attributi:

• gcp.gce.instance_group_manager.name
• gcp.gce.instance_group_manager.region o gcp.gce.instance_group_manager.zone