Este documento descreve a API Telemetry (OTLP), que implementa o protocolo OTLP OpenTelemetry. Esta API foi concebida para utilização com aplicações que são instrumentadas através de um dos SDKs OpenTelemetry.
Por que motivo deve usar a API Telemetry
O OpenTelemetry é um projeto de código aberto com suporte da Google Cloud Google, com engenheiros disponíveis para garantir o suporte para carregar e visualizar os seus dados de rastreio. Google Cloud
Quando usa a API Telemetry, os seus dados são armazenados num formato geralmente consistente com os ficheiros proto definidos pelo protocolo OTLP 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, aplicam-se os limites da API Telemetry. Estes limites são frequentemente mais generosos do que os da Cloud Trace API. Por último, a sua instrumentação não depende de um exportador específico do Google Cloud.
Para saber mais acerca do formato de armazenamento, consulte o Esquema para dados de rastreio.
Quando usar a API Telemetry
Recomendamos que envie os dados de rastreio para o seu Google Cloud projeto através da API Telemetry. Esta API oferece compatibilidade com o ecossistema OpenTelemetry de código aberto e os respetivos limites são frequentemente mais generosos do que os limites da Cloud Trace API, que é umaGoogle Cloud API proprietária. Algumas funcionalidades, como a monitorização de aplicações, baseiam-se em informações que só estão disponíveis quando os dados de rastreio são enviados para a API Telemetry.
Quando instrumenta as suas aplicações para enviar dados de rastreio para o seu Google Cloud projeto, recomendamos que faça uma das seguintes ações:
- Use um exportador que escreva OTLP num coletor, que, em seguida, envia os seus dados de rastreio para a API Telemetry.
- Use um exportador OTLP no processo suportado por uma biblioteca OpenTelemetry que envie telemetria para a API Telemetry. Não existe um coletor com esta configuração.
Para ver informações sobre como usar a API Telemetry, consulte o artigo Migre do exportador do Cloud Trace para o ponto final OTLP.
Onde ver os dados carregados
Os dados de rastreio carregados através da API Telemetry podem ser vistos na página Explorador de rastreios. Para obter informações sobre como ver os dados de rastreio, consulte o artigo Encontre e explore rastreios.
Autenticação
Os exportadores têm de estar autorizados a enviar dados para o seu Google Cloud projeto. Por exemplo, pode configurar o exportador com as suas Google Cloud credenciais predefinidas da aplicação (ADC) adicionando uma biblioteca de autenticação Google específica do idioma à sua aplicação. Para mais informações e código de exemplo, consulte o artigo Configure a autenticação.
Suporte dos VPC Service Controls
O serviço da API Telemetry, cujo nome de serviço é telemetry.googleapis.com, é um serviço suportado pelos VPC Service Controls. Quaisquer restrições dos VPC Service Controls
que criar para o serviço da API Telemetry aplicam-se
apenas a esse serviço. Essas restrições não se aplicam a outros serviços, incluindo serviços como o serviço cloudtrace.googleapis.com, que também podem carregar dados de rastreio.
Para mais informações, consulte o seguinte:
Cloud Trace e residência dos dados
Se estiver a usar 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 rastreio.