Visão geral da API Telemetry (OTLP)

Este documento descreve a API de telemetria (OTLP), que implementa o protocolo OTLP do OpenTelemetry. Essa API foi projetada para uso com aplicativos instrumentados usando um dos SDKs do OpenTelemetry ou que usam qualquer coletor do OpenTelemetry.

O OpenTelemetry é um projeto de código aberto compatível com o Google Cloude com engenheiros do Google Cloudpara garantir o suporte à ingestão e visualização da sua telemetria.

Para saber mais sobre essa API, consulte os seguintes documentos de referência:

Práticas recomendadas

Ao instrumentar seus aplicativos para enviar dados de rastreamento ao projetoGoogle Cloud , recomendamos usar um exportador que grava dados formatados em OTLP em um coletor, que envia os dados de rastreamento à API Telemetry. No seu coletor, especifique apenas o URL raiz:

exporters:
  otlphttp:
    encoding: proto
    endpoint: https://telemetry.googleapis.com

O OpenTelemetry detecta o tipo de dados e anexa automaticamente /v1/traces, /v1/metrics ou /v1/logs, conforme apropriado. Para mais informações, consulte Solicitação OTLP/HTTP.

Para exemplos que exportam dados de rastreamento ou métricas para a API Telemetry, consulte os seguintes documentos:

Quando não é possível usar um coletor, use uma biblioteca do OpenTelemetry que contenha um exportador OTLP no processo para enviar telemetria à API Telemetry. Para saber como exportar dados de rastreamento diretamente, consulte Exportador do Cloud Trace para o endpoint OTLP.

Autenticação

Configure os exportadores com as credenciais necessárias para enviar dados ao seu projeto Google Cloud . Por exemplo, ao usar coletores, normalmente você também usa a extensão googleclientauth para autenticar com credenciais do Google.

Para um exemplo de autenticação ao usar a exportação direta de dados de rastreamento, consulte Configurar a autenticação. Este exemplo ilustra como configurar o exportador com suas Google Cloud Application Default Credentials (ADC) e adicionar uma biblioteca de autenticação do Google específica do idioma ao seu aplicativo.

Suporte do VPC Service Controls

O serviço da API Telemetry, cujo nome é telemetry.googleapis.com, é compatível com o VPC Service Controls. Todas as restrições do VPC Service Controls criadas para o serviço da API Telemetry se aplicam somente a esse serviço. Essas restrições não se aplicam a outros serviços, incluindo aqueles como o cloudtrace.googleapis.com, que também podem ingerir dados de rastreamento.

Para ver mais informações, consulte os seguintes tópicos: