Panoramica dell'API Telemetry (OTLP)

Questo documento descrive l'API Telemetry (OTLP), che implementa l'OpenTelemetry Line Protocol. Questa API è progettata per l'utilizzo con applicazioni instrumentate utilizzando uno degli SDK OpenTelemetry o che utilizzano qualsiasi OpenTelemetry Collector.

OpenTelemetry è un progetto open source supportato da Google Cloudcon ingegneri Google Cloud assegnati per garantire 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 tue applicazioni per inviare dati di traccia al tuo progettoGoogle Cloud , ti consigliamo di utilizzare un esportatore che scriva 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:

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 all'endpoint OTLP.

Autenticazione

Devi configurare gli esportatori con le credenziali necessarie per inviare i dati al tuo progetto Google Cloud . Ad esempio, quando utilizzi i raccoglitori, in genere utilizzi anche 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 Configura l'autenticazione. Questo esempio mostra 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.

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 limitazioni dei Controlli di servizio VPC che crei per il servizio API Telemetry si applicano solo a quel servizio. Queste limitazioni non si applicano ad altri servizi, inclusi quelli come il servizio cloudtrace.googleapis.com, che possono 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 e endpoint regionali:

  • Endpoint globale: telemetry.googleapis.com. Per questo endpoint, dopo che Google Cloud Observability completa 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 completa 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 traccia vengono archiviati. Il servizio di backend sposta automaticamente i dati tra le regioni quando necessario.
    • I dati delle metriche vengono archiviati solo quando l'etichetta di località allegata 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 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 posizioni dei bucket supportate.