Este documento descreve por que recomendamos enviar os dados de rastreamento para o projetoGoogle Cloud usando a API Telemetry (OTLP), que implementa o protocolo OTLP do OpenTelemetry. Ele também fornece orientações sobre como instrumentar seus aplicativos e onde você pode ver os dados de rastreamento. É possível usar a API Telemetry ao instrumentar seus aplicativos usando um dos SDKs do OpenTelemetry ou um coletor do OpenTelemetry.
Recomendamos a API Telemetry pelo seguinte motivo:
A API oferece compatibilidade com o ecossistema de código aberto OpenTelemetry e seus limites costumam ser mais generosos do que os da API Cloud Trace, que é uma API Google Cloud proprietária.
Os dados de rastreamento são armazenados em um formato geralmente consistente com os arquivos proto definidos pelo protocolo OTLP do OpenTelemetry. Alguns campos podem ser convertidos de um tipo de dados específico do OpenTelemetry para um tipo de dados JSON antes do armazenamento. Para saber mais sobre o formato de armazenamento, consulte Esquema para dados de rastreamento.
Sua instrumentação não depende de um exportador específico do Google Cloud.
Alguns recursos, como o Application Monitoring, dependem de informações que estão disponíveis somente quando você envia dados de rastreamento para a API Telemetry.
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.
Práticas recomendadas
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 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.
Autenticação
Configure os exportadores com as credenciais necessárias para enviar dados de rastreamento ao projeto Google Cloud . Por exemplo, para configurar o exportador com suas Google Cloud Application Default Credentials (ADC), adicione uma biblioteca de autenticação do Google específica da linguagem ao seu aplicativo. Para mais informações e exemplos de código, consulte Configurar a autenticação.
Cloud Trace e residência de dados
Se você estiver usando o Assured Workloads porque tem requisitos de residência de dados ou Nível de impacto 4 (IL4), não use a API Telemetry para enviar intervalos de rastreamento ao seu projeto.
Onde conferir os dados ingeridos
É possível conferir os dados de trace usando as páginas Explorador de rastreamentos e Análise de registros. Para mais informações, consulte: