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.
Por que usar a API Telemetry
O OpenTelemetry é um projeto de código aberto compatível com o Google Cloud, com engenheiros Google Cloudpara garantir o suporte à ingestão e visualização dos dados de rastreamento.
Quando você usa a API Telemetry, seus dados são armazenados em um formato geralmente consistente com os arquivos proto definidos pelo protocolo OTLP do OpenTelemetry. No entanto, os campos podem ser convertidos de um tipo de dados específico do OpenTelemetry para um tipo de dados JSON antes do armazenamento. Além disso, os limites da API Telemetry se aplicam. Esses limites costumam ser mais generosos do que os da API Cloud Trace. Por fim, sua instrumentação não depende de um exportador específico do Google Cloud.
Para saber mais sobre o formato de armazenamento, consulte Esquema para dados de rastreamento.
Quando usar a API Telemetry
Ao instrumentar seus aplicativos para enviar dados de rastreamento ao seu projetoGoogle Cloud , recomendamos que você faça uma das seguintes ações:
- Use um exportador que grava OTLP em um coletor, que envia os dados de rastreamento para a API Telemetry.
- Use um exportador OTLP no processo compatível com uma biblioteca do OpenTelemetry que envia telemetria para a API Telemetry. Não há um coletor com essa configuração.
Para informações sobre como usar a API Telemetry, consulte Migrar do exportador do Cloud Trace para o endpoint OTLP.
Onde visualizar os dados ingeridos
Os dados de rastreamento ingeridos pela API Telemetry podem ser visualizados usando a página Explorador de rastreamento. Para informações sobre como visualizar seus dados de trace, consulte Encontrar e explorar traces.
Autenticação
Os exportadores precisam estar autorizados a enviar dados para o projeto Google Cloud . Por exemplo, é possível configurar o exportador com suas credenciais padrão do aplicativo (ADC) Google Cloudadicionando uma biblioteca de autenticação do Google específica da linguagem ao aplicativo. Para mais informações e exemplos de código, consulte Configurar a autenticação.
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 o cloudtrace.googleapis.com, que também pode ingerir dados de rastreamento.
Para ver mais informações, consulte os seguintes tópicos: