OpenTelemetry (OTel) é um projeto de código aberto que fornece um padrão independente de fornecedor para coletar, processar e exportar dados de telemetria de sistemas distribuídos (como uma arquitetura de microsserviços). Essa abordagem simplificada e universal da observabilidade facilita a análise do desempenho e do comportamento do software pelos desenvolvedores, permitindo que diagnostiquem e depurem problemas em suas aplicações com mais facilidade. OTel coleta os seguintes dados:

  • Rastreamentos – “Onde está o problema?”
  • Métricas – “Há algum problema?”
  • Logs – “Qual é o problema?”

OTel não é uma linguagem de programação nem um produto. Este projeto de código aberto existe desde 2019 e atualmente é mantido pela Cloud Native Computing Foundation (CNCF).

Assista a este vídeo para saber como começar:

Tipos de dados gerados pelo OTel

Rastreamentos

Um trace registra os eventos que ocorrem durante uma operação, como o processamento de uma única requisição. O trace é dividido em uma série de spans, cada um representando uma unidade de trabalho.

Por exemplo, o trace de uma requisição web pode incluir três spans:

  • Recebendo a solicitação
  • Consultando o banco de dados
  • Enviando uma resposta

Um trace divide um fluxo de dados, que pode incluir vários serviços, em uma série de segmentos ordenados cronologicamente para ajudar você a entender com facilidade:

  • Todas as etapas que ocorreram em cada segmento
  • A ordem em que os blocos foram executados
  • Quanto tempo durou cada etapa
  • Metadados sobre cada etapa

Depois que o OTel gera os traces, a próxima etapa é exportá-los para um backend de rastreamento ou uma ferramenta de análise. OTel fornece um conjunto de exportadores para backends populares, como Jaeger, Zipkin e AWS X‑Ray. Esses serviços oferecem ferramentas para analisar e visualizar dados de traces.

Métricas

No OTel, as métricas são medições de aspectos específicos do comportamento de um sistema operacional e são coletadas ao longo do tempo como pares de chave e valor (conhecidos como rótulos de métricas). Os pares de chave e valor fornecem contexto sobre a medição ao longo do tempo. Por exemplo, uma métrica do tempo de resposta de um serviço web pode incluir rótulos para o código de status HTTP, o endpoint e o método HTTP. Todas as métricas também recebem um carimbo de data/hora, igualmente para permitir a ordenação cronológica.

Logs

Os logs são o método mais antigo e comum para entender o que está acontecendo com um determinado serviço. Geralmente, são gerados em formato de texto e precisam ser analisados para fornecer informações úteis. O suporte a logs no OTel ainda é experimental.

Para saber mais sobre o que nossos arquitetos de soluções descobriram ao comparar os recursos de observabilidade do OTel com os de outras ferramentas de observabilidade, confira Integração do OpenTelemetry à arquitetura de referência de aplicações modernas – Um relatório de progresso em nosso blog.

Instrumentação do OTel

O OTel se integra a muitas linguagens de programação populares, bibliotecas e frameworks. O suporte a algumas linguagens é mais abrangente do que a outras. Por exemplo, as bibliotecas de instrumentação para JavaScript têm implementações classificadas como “estáveis” para rastreamento e métricas, além de oferecerem um dos suportes mais estáveis a logs. Elas também oferecem uma opção de instrumentação automática que permite começar a receber rastros sem adicionar nenhum código específico de instrumentação à lógica do seu serviço. Por outro lado, linguagens como Go têm suporte menos maduro a métricas e logs e não contam com recursos de instrumentação automática.

Objetivos de telemetria

Ao configurar a instrumentação de telemetria, o ideal é começar com um conjunto de objetivos mais bem definidos do que “enviar tudo e torcer para obter insights”. Embora só seja possível conhecer todo o potencial dos dados depois de analisá-los, definir alguns requisitos mínimos ajuda a garantir o bom funcionamento e a manutenção dos seus serviços.

Podem ser questões técnicas como:

  • Quero saber quando meu serviço está sobrecarregado e precisa de mais recursos.
  • Quero saber se meu serviço está reiniciando com frequência.

Mas também podem ser questões relacionadas ao produto e à experiência do usuário, como:

  • Quero que os usuários vejam novas mensagens no sistema em até cinco segundos.
  • Quero que as notificações sejam enviadas em até um minuto após o envio de uma mensagem.

Como exemplo do nosso tutorial Como usar o rastreamento do OpenTelemetry para entender seus microsserviços, você pode definir os seguintes objetivos principais:

  • Entender todas as etapas pelas quais uma requisição passa para concluir o novo fluxo de mensagens.
  • Verifique se o fluxo do usuário foi concluído com sucesso.
  • Tenha confiança de que o fluxo do usuário é executado em menos de cinco segundos do início ao fim (em circunstâncias “normais”).
  • Saiba se o serviço de notificação está processando o evento (enviado pelo serviço de mensagens) em tempo hábil.

Implementação do OTel

O OTel oferece aos desenvolvedores um conjunto único de interfaces de programação de aplicações (APIs), kits de desenvolvimento de software (SDKs) e bibliotecas de instrumentação que podem ser usados para instrumentar suas aplicações de forma consistente e padronizada.

Como o formato dos dados produzidos pelo OTel é considerado um padrão do setor, diversas soluções de agregação e visualização de telemetria o aceitam. Você pode escolher uma solução hospedada em infraestrutura própria, como o Jaeger (como fizemos neste tutorial), ou optar por uma solução de software como serviço (SaaS), como o SumoLogic ou o SigNoz.

Para gerenciar os três tipos de telemetria, a única alternativa ao OTel é combinar várias ferramentas. Isso adiciona ainda mais complexidade àquela já inerente à operação de uma arquitetura e infraestrutura de microsserviços.

O que é uma API no contexto do OTel?

As APIs definem os métodos, as funções e os protocolos usados pelos componentes de software para interagir entre si. As APIs do OTel definem um conjunto padrão de métodos e protocolos que os desenvolvedores podem usar para instrumentar suas aplicações e coletar dados de telemetria.

O que é um SDK no contexto do OTel?

SDKs são ferramentas de desenvolvimento de software fornecidas pelo autor de um padrão ou aplicativo que facilitam a criação de aplicações compatíveis com esse padrão ou que interajam com o aplicativo. Os SDKs geralmente incluem bibliotecas, exemplos de código, documentação e ferramentas para testes, depuração e otimização de desempenho. O OTel fornece SDKs para rastreamento, métricas e gerenciamento de recursos.