OpenTelemetry è un progetto open source supportato Google Cloudcon Google Cloud ingegneri che garantiscono il supporto per l'importazione e la visualizzazione della telemetria.
Per saperne di più su questa API, consulta i seguenti documenti di riferimento:
Best practice
Quando instrumenti le applicazioni per inviare dati di traccia al tuo Google Cloud progetto, ti consigliamo di utilizzare un esportatore che scrive i dati in formato OTLP in un agente di raccolta, che poi invia i dati di traccia all'API Telemetry. Nell'agente di raccolta, specifica solo l'URL di base:
exporters:
otlphttp:
encoding: proto
endpoint: https://telemetry.googleapis.com
OpenTelemetry rileva il tipo di dati e aggiunge automaticamente /v1/traces, /v1/metrics o /v1/logs, a seconda dei casi. Per saperne di più, consulta
Richiesta OTLP/HTTP.
Per esempi di esportazione di dati di traccia o metriche nell'API Telemetry, consulta i seguenti documenti:
- Panoramica degli esempi di instrumentazione basati su collettori.
- Panoramica dell'importazione di metriche OTLP.
Quando non puoi utilizzare un agente di raccolta, puoi utilizzare una libreria OpenTelemetry che contiene un esportatore OTLP in-process per inviare la telemetria all'API Telemetry. Per scoprire come esportare direttamente i dati di traccia, consulta Esportatore Cloud Trace nell'endpoint OTLP.
Autenticazione
Devi configurare gli esportatori con le credenziali necessarie per inviare
i dati al tuo Google Cloud progetto. Ad esempio, quando utilizzi i collettori, in genere utilizzi l'estensione googleclientauth per l'autenticazione con le credenziali Google.
Per un esempio di autenticazione quando utilizzi l'esportazione diretta dei dati di traccia, consulta Configurare l'autenticazione. Questo esempio illustra come configurare l'esportatore con le tue Google Cloud credenziali predefinite dell'applicazione (ADC) e aggiungere una libreria di autenticazione Google specifica per la lingua alla tua applicazione.
Per inviare dati di telemetria al tuo Google Cloud progetto utilizzando l'API Telemetry, devi anche:
- Configurare un progetto di quota. Per saperne di più, consulta Impostare il progetto di quota.
- Concedere all'utente o al account di servizio utilizzato dall'applicazione il
ruolo Service Usage Consumer (
roles/serviceusage.serviceUsageConsumer) nel progetto di quota. Concedere all'utente o al account di servizio utilizzato dall'applicazione i seguenti ruoli nel tuo progetto:
- Writer log (
roles/logging.logWriter) - Monitoring Metric Writer (
roles/monitoring.metricWriter) - Cloud Telemetry Traces Writer (
roles/telemetry.tracesWriter)
- Writer log (
Supporto dei Controlli di servizio VPC
Il servizio API Telemetry, il cui nome servizio è telemetry.googleapis.com, è un servizio supportato dai Controlli di servizio VPC. Eventuali restrizioni dei Controlli di servizio VPC create per il servizio API Telemetry si applicano solo a quel servizio. Queste restrizioni non si applicano ad altri servizi, inclusi quelli come il servizio cloudtrace.googleapis.com, che può anche importare dati di traccia.
Per ulteriori informazioni, consulta le seguenti risorse:
Endpoint di servizio
Un endpoint di servizio è un URL di base che specifica l' indirizzo di rete di un servizio API. L'API Telemetry supporta un endpoint globale ed endpoint regionali:
Endpoint globale:
telemetry.googleapis.com. Per questo endpoint, dopo che Google Cloud Observability ha completato correttamente tutti i passaggi di convalida, invia i dati a un servizio di backend per l'archiviazione.Endpoint regionali:
telemetry.REGION.rep.googleapis.com, dove REGION è una regione supportata. Per questi endpoint, dopo che Google Cloud Observability ha completato correttamente tutti i passaggi di convalida, invia i dati a un servizio di backend. Questo servizio archivia o elimina i dati:- I dati di log e di traccia vengono archiviati. Il servizio di backend sposta automaticamente i dati tra le regioni, se necessario.
- I dati delle metriche vengono archiviati solo quando l'etichetta della località collegata ai dati corrisponde alla regione dell'endpoint o a una zona all'interno di quella regione.
Per un elenco degli endpoint regionali supportati, consulta le pagine di riferimento dell'API.
L'importazione dei dati di traccia può attivare la creazione di un bucket di osservabilità. Tuttavia, l'utilizzo di un endpoint regionale non influisce sulla posizione in cui il sistema crea il bucket di osservabilità. Il sistema determina la posizione di un bucket di osservabilità utilizzando le impostazioni predefinite, le policy dell'organizzazione e l'insieme delle località dei bucket supportate.