Raccogliere metriche e tracce OpenTelemetry Protocol (OTLP)

Questo documento descrive come utilizzare Ops Agent e il ricevitore OpenTelemetry Protocol (OTLP) per raccogliere metriche e tracce definite dall'utente dalle applicazioni instrumentate utilizzando OpenTelemetry ed eseguite su Compute Engine.

Questo documento è organizzato come segue:

Panoramica dell'utilizzo del ricevitore OTLP

Con il ricevitore OTLP di Ops Agent puoi:

  • Strumenta l'applicazione utilizzando uno degli SDK specifici per il linguaggio per OpenTelemetry. Per informazioni sulle lingue supportate, consulta OpenTelemetry instrumentation. La combinazione di SDK OpenTelemetry e dell'Ops Agent ti consente di:
    • Raccogli le metriche OTLP dalla tua applicazione e inviale a Cloud Monitoring per l'analisi.
    • Raccogli gli intervalli OTLP (dati di traccia) dalla tua applicazione e poi inviali a Cloud Trace per l'analisi.
  • Raccogli le tracce da applicazioni di terze parti che dispongono del supporto integrato per OTLP o plug-in con questo supporto, come Nginx. Il ricevitore OTLP in Ops Agent può raccogliere queste tracce. Per un esempio, consulta il modulo nginx di OpenTelemetry.
  • Utilizza la strumentazione personalizzata di OpenTelemetry.
  • Utilizza la strumentazione automatica OpenTelemetry.

Puoi utilizzare il ricevitore per raccogliere metriche, tracce o entrambe. Dopo che Ops Agent ha raccolto le metriche, puoi utilizzare le funzionalità di Cloud Monitoring, tra cui grafici, dashboard e criteri di avviso, per monitorarle. Se la tua applicazione invia anche dati di traccia, puoi utilizzare Cloud Trace per analizzarli.

Vantaggi

Prima della disponibilità del plug-in OTLP per Ops Agent, i modi principali per instrumentare le applicazioni al fine di raccogliere metriche e tracce definite dall'utente includevano quanto segue:

  • Utilizzo di librerie client che implementano l'API Monitoring o l'API Trace.
  • Utilizzo delle librerie OpenCensus precedenti.

L'utilizzo di OpenTelemetry con il ricevitore OTLP offre diversi vantaggi rispetto a questi metodi, tra cui:

  • OpenTelemetry sostituisce OpenCensus. Il progetto OpenCensus è in fase di archiviazione. Per ulteriori informazioni, vedi Che cos'è OpenTelemetry?.
  • L'importazione è controllata a livello di agente, quindi non è necessario eseguire nuovamente il deployment delle applicazioni se la configurazione dell'agente cambia.
  • Le applicazioni non devono configurare le credenziali Google Cloud; tutta l'autorizzazione viene gestita a livello di agente.
  • Il codice dell'applicazione non contiene codice di monitoraggio o tracciamento specifico per Google Cloud. Non è necessario utilizzare direttamente l'API Monitoring o l'API Trace.
  • L'applicazione invia i dati a Ops Agent e, se si arresta in modo anomalo, i dati raccolti da Ops Agent non andranno persi.

Limitazioni

L'ascoltatore OTLP esposto dal ricevitore di Ops Agent supporta il trasporto gRPC. HTTP, che viene utilizzato principalmente per i client JavaScript, non è supportato. Per ulteriori informazioni sul protocollo OpenTelemetry, consulta Dettagli del protocollo.

Il destinatario OTLP non raccoglie i log. Puoi raccogliere i log utilizzando Ops Agent e altri ricevitori e puoi includere le informazioni sui log negli intervalli OTLP, ma il ricevitore OTLP non supporta la raccolta diretta dei log. Per informazioni sull'utilizzo di Ops Agent per raccogliere i log, consulta Configurazioni di logging.

Prerequisiti

Per raccogliere le metriche e le tracce OTLP utilizzando il ricevitore OTLP e l'Ops Agent, devi installare l'agente operativo versione 2.37.0 o successiva.

Questo documento presuppone che tu abbia già un'applicazione basata su OpenTelemetry scritta utilizzando uno degli SDK OpenTelemetry. Questo documento non tratta dell'utilizzo degli SDK OpenTelemetry. Per informazioni sugli SDK e sulle lingue supportate, consulta OpenTelemetry Instrumentation.

Configurazione dell'agente operativo

Per configurare l'Ops Agent in modo che utilizzi il ricevitore OTLP:

  1. Modifica il file di configurazione utente di Ops Agent in modo da includere il ricevitore OTLP.
  2. Riavvia Ops Agent.

Le sezioni seguenti descrivono ogni passaggio.

Modifica il file di configurazione utente di Ops Agent

Aggiungi gli elementi di configurazione per il ricevitore OTLP al file di configurazione utente per Ops Agent:

  • Per Linux: /etc/google-cloud-ops-agent/config.yaml
  • Per Windows: C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.yaml

Per informazioni generali sulla configurazione dell'agente, consulta Modello di configurazione.

Il ricevitore OTLP introduce la sezione di configurazione combined per l'Ops Agent. L'utilizzo del destinatario richiede la configurazione dei servizi per le metriche e le tracce, anche se non li utilizzi entrambi.

Le sezioni seguenti descrivono i passaggi di configurazione del ricevitore OTLP.

Aggiungi la sezione combined Destinatario

Posiziona il ricevitore per le metriche e le tracce OTLP nella sezione combined. Nella sezione combined non sono consentiti processori o servizi. Non devi configurare nessun altro ricevitore con lo stesso nome di un ricevitore nella sezione combined. L'esempio seguente utilizza otlp come nome del destinatario.

La configurazione minima di combined per OTLP è la seguente:

combined:
  receivers:
    otlp:
      type: otlp

Il ricevitore otlp ha le seguenti opzioni di configurazione:

  • type: obbligatorio. Deve essere otlp
  • grpc_endpoint: facoltativo. L'endpoint gRPC su cui il ricevitore OTLP è in ascolto. Il valore predefinito è 0.0.0.0:4317.
  • metrics_mode: facoltativo. Il valore predefinito è googlemanagedprometheus, il che significa che il destinatario invia le metriche OTLP come metriche in formato Prometheus utilizzando l'API Prometheus utilizzata anche da Managed Service per Prometheus.

    Per inviare le metriche come metriche personalizzate di Cloud Monitoring utilizzando invece l'API Monitoring, imposta l'opzione metrics_mode sul valore googlecloudmonitoring.

    Questa scelta influisce sul modo in cui le metriche vengono importate e misurate per la fatturazione. Per ulteriori informazioni sui formati delle metriche, consulta Formati di importazione per le metriche OTLP.

Aggiungere pipeline OTLP ai tuoi servizi

Il ricevitore OTLP può raccogliere metriche e tracce, quindi devi definire un servizio per le metriche e per le tracce. Se non vuoi raccogliere né metriche né tracce, puoi creare servizi vuoti. Se hai già servizi con altre pipeline, puoi aggiungervi la pipeline OTLP.

Di seguito sono riportati i servizi metrics e traces con il ricevitore OTLP incluso nelle pipeline:

combined:
  receivers:
    otlp:
      type: otlp
metrics:
  service:
    pipelines:
      otlp:
        receivers: [otlp]
traces:
  service:
    pipelines:
      otlp:
        receivers: [otlp]

Se non vuoi utilizzare il servizio metrics o traces per la raccolta OTLP, lascia il ricevitore OTLP fuori dalla pipeline per il servizio. Il servizio deve esistere, anche se non ha pipeline. Se l'applicazione invia dati di un determinato tipo e non esiste una pipeline corrispondente che includa il ricevente, Ops Agent elimina i dati.

Riavvia l'Ops Agent

Per applicare le modifiche alla configurazione, devi riavviare Ops Agent.

Linux

  1. Per riavviare l'agente, esegui il seguente comando sull'istanza:
    sudo systemctl restart google-cloud-ops-agent
    
  2. Per verificare che l'agente sia stato riavviato, esegui il seguente comando e verifica che i componenti "Metrics Agent" e "Logging Agent" siano stati avviati:
    sudo systemctl status "google-cloud-ops-agent*"
    

Windows

  1. Connettiti all'istanza utilizzando RDP o uno strumento simile e accedi a Windows.
  2. Apri un terminale PowerShell con privilegi amministrativi facendo clic con il tasto destro del mouse sull'icona di PowerShell e selezionando Esegui come amministratore.
  3. Per riavviare l'agente, esegui il seguente comando PowerShell:
    Restart-Service google-cloud-ops-agent -Force
    
  4. Per verificare che l'agente sia stato riavviato, esegui il seguente comando e verifica che i componenti "Metrics Agent" e "Logging Agent" siano stati avviati:
    Get-Service google-cloud-ops-agent*
    

Raccogliere le metriche OTLP

Quando utilizzi il ricevitore OTLP per raccogliere le metriche dalle tue applicazioni OpenTelemetry, la scelta di configurazione principale per il ricevitore è l'API che vuoi utilizzare per importare le metriche.

Puoi effettuare questa scelta modificando l'opzione metrics_mode nella configurazione del ricevitore otlp o utilizzando il valore predefinito. La scelta influisce sul modo in cui le metriche OTLP vengono importate in Cloud Monitoring e su come vengono misurati questi dati a fini di fatturazione.

La scelta metrics_mode non influisce sulla tua capacità di creare grafici, dashboard e criteri di avviso in Monitoraggio.

Le sezioni seguenti descrivono le differenze nei formati utilizzati dalle modalità di metrica e come eseguire query sui dati importati per utilizzarli in Monitoraggio.

Formati di importazione per le metriche OTLP

Il ricevitore OTLP fornisce l'opzione metrics_mode, che specifica l'API utilizzata per importare i dati delle metriche. Per impostazione predefinita, il ricevitore utilizza l'API Prometheus. Il valore predefinito per l'opzione metrics_mode è googlemanagedprometheus. Le metriche vengono importate utilizzando la stessa API utilizzata da Managed Service per Prometheus.

Puoi configurare il destinatario in modo che invii i dati delle metriche all'API Cloud Monitoring. Per inviare dati all'API Monitoring, imposta il valore dell'opzione metrics_mode su googlecloudmonitoring, come mostrato nell'esempio seguente:

combined:
  receivers:
    otlp:
      type: otlp
      metrics_mode: googlecloudmonitoring

Il formato di importazione utilizzato determina la modalità di mappatura delle metriche OTLP in Cloud Monitoring. Puoi creare grafici, dashboard e criteri di avviso in Monitoraggio per le metriche di entrambi i formati, ma fai riferimento alle metriche in modo diverso nelle query.

Il formato di importazione determina anche il modello di prezzo utilizzato per l'importazione dei dati.

Le seguenti sezioni descrivono i prezzi, le differenze strutturali tra una metrica importata dall'API Prometheus e la stessa metrica importata dall'API Monitoring e come fare riferimento alle metriche nelle query.

Prezzi e quote

Il formato di importazione che utilizzi determina la modalità di addebito delle metriche OTLP:

  • API Prometheus: quando utilizzi l'API Prometheus per importare le metriche della tua applicazione, i dati sono soggetti a prezzi basati su campioni, come se le metriche fossero state importate utilizzando Managed Service per Prometheus.

  • API Monitoring: quando utilizzi l'API Monitoring per importare le metriche della tua applicazione, i dati sono soggetti a prezzi basati sul volume, come i dati di altre integrazioni con l'Ops Agent.

Le metriche importate utilizzando il ricevitore OTLP sono considerate tipi di metriche "personalizzate" quando vengono importate in Cloud Monitoring e sono soggette alle quote e ai limiti per le metriche personalizzate.

Struttura delle metriche

Cloud Monitoring descrive il formato dei dati delle metriche utilizzando uno schema chiamato descrittore della metrica. Il descrittore della metrica include il nome della metrica, il tipo di dati dei valori della metrica, la relazione tra ciascun valore e i valori precedenti e le eventuali etichette associate ai valori. Se configuri il ricevitore OTLP per importare le metriche utilizzando l'API Prometheus, il descrittore della metrica creato è diverso da quello creato quando utilizzi l'API Monitoring.

API Prometheus: quando utilizzi l'API Prometheus per importare le metriche della tua applicazione, ogni metrica viene trasformata utilizzando la trasformazione OpenTelemetry-to-Prometheus standard e mappata a un tipo di risorsa monitorata da Cloud Monitoring.

  • La trasformazione include le seguenti modifiche:
    • Al nome della metrica OTLP viene anteposto il prefissoprometheus.googleapis.com/.
    • I caratteri non alfanumerici, ad esempio i punti (.), nel nome della metrica OTLP vengono sostituiti da trattini bassi (_).
    • Il nome della metrica OTLP è seguito da una stringa che indica il tipo di metrica, ad esempio /gauge o /counter.
  • Le seguenti etichette, compilate con i valori della risorsa OTLP, vengono aggiunte alla metrica:
    • instance_name: il valore dell'attributo della risorsa host.name.
    • machine_type: il valore dell'attributo della risorsa host.type.
  • La risorsa monitorata registrata con le misurazioni delle metriche è di tipo generico prometheus_target. La serie temporale Prometheus generata include le seguenti etichette della risorsa prometheus_target, completate con i valori della risorsa OTLP:

    • location: il valore dell'attributo della risorsa cloud.availability_zone.
    • namespace: il valore dell'attributo della risorsa host.id.

    Il tipo di risorsa prometheus_target include anche le seguenti etichette:

    • project_id: l'identificatore del progetto Google Cloud, ad esempio my-project, in cui è in esecuzione l&#Ops Agent.
    • cluster: il valore è sempre __gce__ quando le metriche vengono raccolte dall'Ops Agent.

Se nei dati OTLP in entrata mancano gli attributi delle risorse utilizzati per i valori delle etichette, i valori vengono ricavati dalle informazioni sulla VM in cui è in esecuzione Ops Agent. Questo comportamento significa che i dati OTLP senza questi attributi della risorsa vengono visualizzati con le stesse etichette dei dati raccolti dal ricevitore Prometheus di Ops Agent.

API Monitoring:quando utilizzi l'API Monitoring per importare le metriche della tua applicazione, ogni metrica viene gestita come segue:

  • Al nome della metrica OTLP viene anteposto il prefisso workload.googleapis.com/, a meno che il nome della metrica OTLP non contenga già questa stringa o un altro dominio metrico valido, come custom.googleapis.com. Ti consigliamo di utilizzare il dominio "workload".
  • La risorsa monitorata registrata con le misurazioni delle metriche è il tipo di macchina virtuale Compute Engine gce_instance.

Gli esempi riportati di seguito mostrano i descrittori delle metriche per una coppia di metriche OpenTelemetry. Le metriche vengono create da un'applicazione che utilizza la libreria di metriche OpenTelemetry per Go. La scheda API Prometheus mostra il descrittore della metrica creato quando il ricevitore OTLP utilizza la modalità predefinita delle metriche Prometheus. La scheda API di monitoraggio mostra il descrittore della metrica creato quando il ricevitore OTLP utilizza la modalità metrica googlecloudmonitoring.

Non viene apportata alcuna modifica all'applicazione che crea la metrica; l'unica variazione è la modalità metrica utilizzata dal ricevitore OTLP.

L'applicazione crea una metrica indicatore OTLP, otlp.test.gauge, che registra valori in virgola mobile a 64 bit. Le seguenti schede mostrano il descrittore della metrica creato da ogni API di importazione:

API Prometheus

{
  "name": "projects/PROJECT_ID/metricDescriptors/prometheus.googleapis.com/otlp_test_gauge/gauge",
  "labels": [
    {
      "key": "instance_name"
    },
    {
      "key": "machine_type"
    }
  ],
  "metricKind": "GAUGE",
  "valueType": "DOUBLE",
  "type": "prometheus.googleapis.com/otlp_test_gauge/gauge",
  "monitoredResourceTypes": [
    "prometheus_target"
  ]
}

API Monitoring

{
  "name": "projects/PROJECT_ID/metricDescriptors/workload.googleapis.com/otlp.test.gauge",
  "labels": [
    {
      "key": "instrumentation_source"
    }
  ],
  "metricKind": "GAUGE",
  "valueType": "DOUBLE",
  "type": "workload.googleapis.com/otlp.test.gauge",
  "monitoredResourceTypes": [
    "gce_instance",
    ...many other types deleted...
  ]
}

L'applicazione crea una metrica del contatore OTLP, otlp.test.cumulative, che registra valori in virgola mobile a 64 bit in aumento. Le seguenti schede mostrano il descrittore della metrica creato da ogni API di importazione:

API Prometheus

{
  "name": "projects/PROJECT_ID/metricDescriptors/prometheus.googleapis.com/otlp_test_cumulative/counter",
  "labels": [
    {
      "key": "instance_name"
    },
    {
      "key": "machine_type"
    }
  ],
  "metricKind": "CUMULATIVE",
  "valueType": "DOUBLE",
  "type": "prometheus.googleapis.com/otlp_test_cumulative/counter",
  "monitoredResourceTypes": [
    "prometheus_target"
  ]
}

API Monitoring

{
  "name": "projects/PROJECT_ID/metricDescriptors/workload.googleapis.com/otlp.test.cumulative",
  "labels": [
    {
      "key": "instrumentation_source"
    }
  ],
  "metricKind": "CUMULATIVE",
  "valueType": "DOUBLE",
  "type": "workload.googleapis.com/otlp.test.cumulative",
  "monitoredResourceTypes": [
    "gce_instance",
    ...many other types deleted...
  ]
}

La tabella seguente riassume alcune delle differenze di formato imposte dalle API utilizzate per importare le metriche OTLP:

  API Prometheus API Monitoring
Dominio metrica prometheus.googleapis.com workload.googleapis.com
Nome della metrica OTLP Modificato durante l'importazione Utilizzato come fornito
Risorsa monitorata prometheus_target gce_instance

Formati di importazione e query

La modalità di metriche utilizzata nel ricevitore OTLP influisce sul modo in cui esegui query sulle metriche risultanti in Cloud Monitoring quando crei grafici, dashboard e criteri di avviso.

Quando configuri un grafico, una dashboard o un criterio di avviso in Cloud Monitoring, la configurazione include una query per i dati su cui operano il grafico, la dashboard o il criterio di avviso.

Cloud Monitoring supporta i seguenti strumenti per eseguire query sui dati delle metriche:

  • Un'interfaccia basata su Query Builder integrata in strumenti come Metrics Explorer, l'interfaccia di Dashboard Builder e l'interfaccia di configurazione delle norme di avviso.
  • Monitoring Query Language (MQL): un linguaggio di query basato su testo specifico per Cloud Monitoring.
  • Prometheus Query Language (PromQL): il linguaggio di query basato su testo utilizzato da Prometheus open source.

Per informazioni su come eseguire query sulle metriche OTLP utilizzando questi strumenti, consulta quanto segue:

Esegui query sulle metriche OTLP importate utilizzando l'API Prometheus

Questa sezione illustra come eseguire query sulle metriche OTLP importate utilizzando l'API Prometheus, che è la modalità metrica predefinita per il ricevitore OTLP.

Le query si basano sulle metriche OTLP descritte in Struttura delle metriche:

  • otlp.test.gauge: una metrica di indicatore OTLP che registra valori di tipo floating point a 64 bit.
  • otlp.test.cumlative: una metrica del contatore OTLP che registra valori in virgola mobile a 64 bit in aumento.

Queste metriche vengono importate in Cloud Monitoring con i seguenti tipi di metriche, che fungono da nomi:

  • prometheus.googleapis.com/otlp_test_gauge/gauge
  • prometheus.googleapis.com/otlp_test_cumulative/counter

Le metriche importate utilizzando l'API Prometheus vengono scritte in base al tipo di risorsa monitorata prometheus_target.

Le schede mostrano l'aspetto delle query di base quando esegui query sulle metriche utilizzando la console Google Cloud. Questi esempi utilizzano Metrics Explorer, ma i principi sono gli stessi per le dashboard e i criteri di avviso.

Interfaccia di Query Builder

Per utilizzare un'interfaccia di creazione di query per eseguire query sui dati delle metriche, specifica il tipo di metrica e il tipo di risorsa monitorata digitando nei campi abilitati alla ricerca. Esistono molti meno tipi di risorse rispetto ai tipi di metriche, pertanto solitamente è più efficiente cercare il tipo di risorsa e poi utilizzare il menu delle metriche associate per trovare il tipo di metrica.

Se inserisci "prometheus" nel campo di ricerca, i risultati includono la risorsa monitorataprometheus_target, indicata dal nome visualizzato "Prometheus Target", e l'insieme di metriche che scrivono nella risorsa. Le metriche sono categorizzate per nome; le due metriche di esempio vengono visualizzate come categoria Otlp. Puoi selezionare Prometheus/otlp_test_cumulative/counter o Prometheus/otlp_test_gauge/gauge.

Per saperne di più sull'utilizzo di Query Builder, consulta Creare query utilizzando i menu.

Lo screenshot seguente mostra il risultato della query sulla metrica prometheus.googleapis.com/otlp_test_gauge/gauge:

Grafico di Metrics Explorer basato su builder per la metrica del misuratore OTLP importata utilizzando l'API Prometheus.

Lo screenshot seguente mostra il risultato della query sulla metrica prometheus.googleapis.com/otlp_test_cumulative/counter:

Grafico di Metrics Explorer basato su builder per la metrica del contatore OTLP importata utilizzando l'API Prometheus.

MQL

Per eseguire query sui dati delle metriche utilizzando MQL, utilizza un'istruzione fetch e specifica il tipo di metrica e il tipo di risorsa monitorata, con :: tra loro. Le query MQL banali per le metriche di esempio sono simili alle seguenti:

  • fetch prometheus.googleapis.com/otlp_test_gauge/gauge::prometheus_target
  • fetch prometheus.googleapis.com/otlp_test_cumulative/counter::prometheus_target

Per ulteriori informazioni sulla creazione di query MQL, consulta Query MQL di esempio.

Lo screenshot seguente mostra il risultato della query sulla metrica prometheus.googleapis.com/otlp_test_gauge/gauge:

Grafico di Esplora metriche MQL per la metrica del misuratore OTLP importata utilizzando l'API Prometheus.

Lo screenshot seguente mostra il risultato della query sulla metrica prometheus.googleapis.com/otlp_test_cumulative/counter:

Grafico di Esplora metriche MQL per la metrica del contatore OTLP importata utilizzando l'API Prometheus.

PromQL

Quando utilizzi PromQL per eseguire query sui dati delle metriche importati utilizzando l'API Prometheus, devi solo specificare la forma modificata del nome della metrica OTLP originale. Non è necessario specificare la stringa con prefissoprometheus.googleapis.com/ o il tipo con suffisso.

Quando la metrica può essere scritta in base a un solo tipo di risorsa monitorata, non è necessario specificare la risorsa. Come descritto in Struttura delle metriche, le metriche OTLP importate utilizzando l'API Prometheus vengono scritte solo in base al tipo di risorsa monitorata prometheus_target. Le query PromQL banali per le metriche di esempio sono le seguenti:

  • otlp_test_gauge
  • otlp_test_cumulative

Per saperne di più sull'utilizzo di PromQL in Cloud Monitoring per eseguire query sulle metriche importate utilizzando l'API Prometheus, consulta Dati di Google Cloud Managed Service per Prometheus in Cloud Monitoring. Per informazioni sul linguaggio PromQL, consulta Eseguire query su Prometheus.

Lo screenshot seguente mostra il risultato della query sulla metrica prometheus.googleapis.com/otlp_test_gauge/gauge:

Grafico di Esplora metriche PromQL per la metrica del misuratore OTLP importata utilizzando l'API Prometheus.

Lo screenshot seguente mostra il risultato della query sulla metrica prometheus.googleapis.com/otlp_test_cumulative/counter:

Grafico di Esplora metriche PromQL per la metrica del contatore OTLP importata utilizzando l'API Prometheus.

Esegui query sulle metriche OTLP importate utilizzando l'API Monitoring

Questa sezione illustra come eseguire query sulle metriche OTLP importate utilizzando l'API Monitoring. Seleziona l'API Cloud Monitoring impostando il campo metrics_mode del destinatario OTLP sul valore googlecloudmonitoring.

Le query si basano sulle metriche OTLP descritte in Struttura delle metriche:

  • otlp.test.gauge: una metrica di indicatore OTLP che registra valori di tipo floating point a 64 bit.
  • otlp.test.cumlative: una metrica del contatore OTLP che registra valori in virgola mobile a 64 bit in aumento.

Queste metriche vengono importate in Cloud Monitoring con i seguenti tipi di metriche, che fungono da nomi:

  • workload.googleapis.com/otlp.test.gauge
  • workload.googleapis.com/otlp.test.cumulative

Le metriche importate utilizzando l'API Monitoring vengono scritte in base al tipo di risorsa monitorata gce_instance.

Le schede mostrano l'aspetto delle query di base quando esegui query sulle metriche utilizzando la console Google Cloud. Questi esempi utilizzano Metrics Explorer, ma i principi sono gli stessi per le dashboard e i criteri di avviso.

Interfaccia di Query Builder

Per utilizzare un'interfaccia di creazione di query per eseguire query sui dati delle metriche, specifica il tipo di metrica e il tipo di risorsa monitorata digitando nei campi abilitati alla ricerca. Esistono molti meno tipi di risorse rispetto ai tipi di metriche, pertanto solitamente è più efficiente cercare il tipo di risorsa e poi utilizzare il menu delle metriche associate per trovare il tipo di metrica.

Se inserisci "gce_instance" nel campo di ricerca, i risultati mostrano il tipo di risorsa in base al nome visualizzato, "Istanza VM", e l'insieme di metriche che scrivono nella risorsa. Le metriche sono classificate per nome. Le due metriche di esempio vengono visualizzate come categoria Otlp. Puoi selezionare Workload/otlp_test_cumulative o Workload/otlp_test_gauge.

Per saperne di più sull'utilizzo di Query Builder, consulta Creare query utilizzando i menu.

Lo screenshot seguente mostra il risultato della query sulla metrica workload.googleapis.com/otlp.test.gauge:

Grafico di Metrics Explorer basato su builder per la metrica del misuratore OTLP importata utilizzando l'API Monitoring.

Lo screenshot seguente mostra il risultato della query sulla metrica workload.googleapis.com/otlp.test.cumulative:

Grafico di Metrics Explorer basato su builder per la metrica del contatore OTLP importata utilizzando l'API Monitoring.

MQL

Per eseguire query sui dati delle metriche utilizzando MQL, utilizza un'istruzione fetch e specifica il tipo di metrica e il tipo di risorsa monitorata, con :: tra loro. Le query MQL banali per le metriche di esempio sono simili alle seguenti:

  • fetch workload.googleapis.com/otlp.test.gauge::gce_instance
  • fetch workload.googleapis.com/otlp.test.cumulative::gce_instance

Per ulteriori informazioni sulla creazione di query MQL, consulta Query MQL di esempio.

Lo screenshot seguente mostra il risultato della query sulla metrica workload.googleapis.com/otlp.test.gauge:

Grafico di Esplora metriche MQL per la metrica del misuratore OTLP importata utilizzando l'API Monitoring.

Lo screenshot seguente mostra il risultato della query sulla metrica workload.googleapis.com/otlp.test.cumulative:

Grafico di Metrics Explorer in MQL per la metrica del contatore OTLP importata utilizzando l'API Monitoring.

PromQL

Quando utilizzi PromQL per eseguire query sui dati delle metriche importati utilizzando l'API Monitoring, devi mappare il nome della metrica alle convenzioni di PromQL. Le regole di mappatura di base includono quanto segue:

  • Sostituisci il primo / con :.
  • Sostituisci tutti gli altri caratteri speciali (inclusi . e altri caratteri /) con _.

Per ulteriori informazioni sulle regole di mappatura, consulta Mappare le metriche di Cloud Monitoring a PromQL.

I tipi di metriche di monitoraggio per le metriche di esempio sono mappati a PromQL come segue:

  • workload_googleapis_com:otlp_test_gauge
  • workload_googleapis_com:otlp_test_cumulative

Quando la metrica può essere scritta in base a un solo tipo di risorsa monitorata, non è necessario specificare la risorsa. Le metriche di esempio sono scritte in base al tipo di risorsa monitorata gce_instance, ma, come descritto in Struttura delle metriche, gce_instance è solo uno dei possibili tipi di metriche. Pertanto, le query PromQL per queste metriche devono includere un filtro per il tipo di risorsa gce_instance. Per includere il filtro, aggiungi la seguente stringa alla fine dei nomi delle metriche mappate: {monitored_resource="gce_instance"}

Per ulteriori informazioni sull'utilizzo di PromQL in Cloud Monitoring, consulta PromQL in Cloud Monitoring. Per informazioni sul linguaggio PromQL, consulta Eseguire query su Prometheus.

Le query PromQL banali per le metriche di esempio sono le seguenti:

  • workload_googleapis_com:otlp_test_gauge{monitored_resource="gce_instance"}
  • workload_googleapis_com:otlp_test_cumulative{monitored_resource="gce_instance"}

Lo screenshot seguente mostra il risultato della query sulla metrica workload.googleapis.com/otlp.test.gauge:

Grafico di Metrics Explorer di PromQL per la metrica del misuratore OTLP importata utilizzando l'API Monitoring.

Lo screenshot seguente mostra il risultato della query sulla metrica workload.googleapis.com/otlp.test.cumulative:

Grafico di Metrics Explorer di PromQL per la metrica del contatore OTLP importata utilizzando l'API Monitoring.

Visualizzare l'utilizzo delle metriche e la diagnostica in Cloud Monitoring

La pagina Gestione delle metriche di Cloud Monitoring fornisce informazioni che possono aiutarti a controllare la spesa per le metriche fatturabili senza influire sull'osservabilità. La pagina Gestione delle metriche riporta le seguenti informazioni:

  • Volumi di importazione sia per la fatturazione basata su byte che su sample, per i domini delle metriche e per le singole metriche.
  • Dati su etichette e cardinalità delle metriche.
  • Numero di letture per ogni metrica.
  • Utilizzo delle metriche nei criteri di avviso e nelle dashboard personalizzate.
  • Tasso di errori di scrittura delle metriche.

Puoi anche utilizzare la pagina Gestione delle metriche per escludere le metriche non necessarie, eliminando il costo di importazione.

Per visualizzare la pagina Gestione delle metriche:

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

    Vai a Gestione delle metriche

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

  2. Nella barra degli strumenti, seleziona l'intervallo di tempo. Per impostazione predefinita, la pagina Gestione delle metriche mostra informazioni sulle metriche raccolte nell'ultimo giorno.

Per ulteriori informazioni sulla pagina Gestione delle metriche, consulta Visualizzare e gestire l'utilizzo delle metriche.

Raccogli le tracce OTLP

Se hai configurato Ops Agent per raccogliere le tracce, ma non ne ricevi alcuna in Cloud Trace quando esegui l'applicazione, potresti dover concedere un ruolo aggiuntivo all'account di servizio Compute Engine utilizzato dall'agente. Per impostazione predefinita, l'account di servizio ottiene i ruoli necessari per scrivere metriche e log, ma non tracce.

Le sezioni seguenti descrivono come concedere all'account di servizio l'autorizzazione Cloud Trace necessaria.

Determina i ruoli concessi all'account di servizio

Per visualizzare i ruoli concessi a un account di servizio, esegui il seguente comando gcloud projects get-iam-policy:

gcloud projects get-iam-policy PROJECT_ID --format="table(bindings.role)" --flatten="bindings[].members" --filter="bindings.members:SERVICE_ACCT_NAME@PROJECT_ID.iam.gserviceaccount.com"

Potresti visualizzare un output simile al seguente:

ROLE
roles/logging.logWriter
roles/monitoring.metricWriter

Se l'output include roles/cloudtrace.agent o roles/cloudtrace.admin, l'account di servizio dispone dell'autorizzazione sufficiente per scrivere le tracce. Per concedere uno di questi ruoli all'account di servizio, consulta la sezione seguente.

Concedi il ruolo Cloud Trace all'account di servizio

Per un account di servizio, in genere è appropriato il ruolo Agente Cloud Trace, roles/cloudtrace.agent. Per concedere questo ruolo all'account di servizio, esegui il seguente comando gcloud projects add-iam-policy-binding:

gcloud projects add-iam-policy-binding PROJECT_ID --member "serviceAccount:SERVICE_ACCT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role="roles/cloudtrace.agent"

Quindi, puoi eseguire il comando gcloud projects get-iam-policy per verificare che la modifica sia stata apportata:

gcloud projects get-iam-policy PROJECT_ID --format="table(bindings.role)" --flatten="bindings[].members" --filter="bindings.members:SERVICE_ACCT_NAME@PROJECT_ID.iam.gserviceaccount.com"

L'output ora include roles/cloudtrace.agent:

ROLE
roles/cloudtrace.agent
roles/logging.logWriter
roles/monitoring.metricWriter

Per saperne di più sulla gestione dei ruoli IAM, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

Dopo aver autorizzato l'account di servizio utilizzato da Ops Agent a scrivere dati in Cloud Trace, quando esegui l'applicazione basata su OpenTelemetry, le tracce vengono visualizzate in Cloud Trace:

Un riquadro dei dettagli della traccia mostra una traccia OTLP.

Disattivare il ricevitore OTLP

Se raccogli sia le metriche sia le tracce OTLP utilizzando Ops Agent, e vuoi disattivare la raccolta delle metriche o delle tracce, ma non di entrambe, procedi nel seguente modo:

  1. Disattiva la raccolta delle metriche o delle tracce apportando una delle seguenti modifiche al file di configurazione utente config.yaml:

    • Rimuovi la pipeline otlp dal servizio metrics.
    • Rimuovi la pipeline otlp dal servizio traces.
  2. Riavvia Ops Agent.

Per disattivare la raccolta di metriche e tracce OTLP da parte di Ops Agent, segui questi passaggi:

  1. Rimuovi la configurazione OTLP dal file di configurazione utente:

    • Elimina l'intera sezione combined, che include il ricevitore otlp.
    • Rimuovi la pipeline otlp dal servizio metrics.
    • Eliminare l'intero servizio traces.
  2. Riavvia Ops Agent.

Passaggi successivi

Dopo aver importato le metriche e le tracce dell'applicazione, puoi utilizzare la console Google Cloud per monitorare e analizzare i dati.