Este documento descreve por que recomendamos que você envie seus dados de trace para o Google Cloud projeto 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 visualizar os dados de trace. É 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 do OpenTelemetry, e os limites dela geralmente são mais generosos do que os da API Cloud Trace, que é uma API proprietária Google Cloud .
Os dados de trace 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 trace.
A instrumentação não depende de um Google Cloudexportador específico.
Alguns recursos, como o Application Monitoring, dependem de informações que só estão disponíveis quando você envia dados de trace para a API Telemetry.
O OpenTelemetry é um projeto de código aberto com Google Cloudsuporte e Google Cloud engenheiros para garantir o suporte à ingestão e visualização da telemetria.
O Google Cloud Observability verifica se a API Cloud Trace está ativada no seu Google Cloud projeto antes de armazenar dados de trace. Isso significa que, se você desativar a API Cloud Trace, o Google Cloud Observability vai descartar os dados de trace enviados para a API Telemetry.
Práticas recomendadas
Ao instrumentar seus aplicativos para enviar dados de trace ao Google Cloud projeto, recomendamos que você faça uma das seguintes ações:
- Use um exportador que grava o OTLP em um Coletor, que então envia os dados de trace para a API Telemetry.
- Use um exportador OTLP no processo com suporte de uma biblioteca do OpenTelemetry que envia telemetria para a API Telemetry. Não há 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
É necessário configurar os exportadores com as credenciais necessárias para enviar dados de trace ao Google Cloud projeto. Por exemplo, para configurar o exportador com o Google Cloud Application Default Credentials (ADC), adicione uma biblioteca de autenticação do Google específica do idioma ao 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 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 períodos de trace ao projeto.
Onde visualizar os dados ingeridos
É possível visualizar os dados de trace usando as páginas Explorador de traces e Análise de observabilidade. Para informações, consulte: