Panoramica dell'API Telemetry (OTLP)

Questo documento descrive l'API Telemetry (OTLP), che implementa il protocollo OTLP di OpenTelemetry. Questa API è progettata per essere utilizzata con applicazioni strumentate utilizzando uno degli SDK OpenTelemetry o che utilizzano qualsiasi agente di raccolta OpenTelemetry.

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 strumenti le applicazioni per inviare i dati di traccia al tuo Google Cloud progetto, ti consigliamo di utilizzare un esportatore che scriva 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:

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 di 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 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 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.

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 create 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: