Início rápido

O OpenTelemetry Collector recebe rastros, métricas e logs, processa a telemetria e a exporta para diversos backends de observabilidade utilizando seus componentes. Para uma visão geral conceitual do Collector, veja Collector.

Você aprenderá a fazer o seguinte em menos de cinco minutos:

• Configurar e executar o OpenTelemetry Collector.
• Enviar telemetria e vê-la sendo processada pelo Collector.

Pré-requisitos

Certifique-se de que seu ambiente de desenvolvimento tenha o seguinte. Esta página pressupõe que você esteja usando bash. Adapte as configurações e comandos conforme necessário para o seu shell de preferência.

• Docker ou outro ambiente de execução compatível com contêineres.
• Go 1.20 ou superior
• A variável de ambiente GOBIN está definida; se não estiver, inicialize-a adequadamente, por exemplo¹:

  export GOBIN=${GOBIN:-$(go env GOPATH)/bin}
  

Configurar o ambiente

1. Baixe a imagem Docker do OpenTelemetry Collector:

docker pull otel/opentelemetry-collector:0.148.0

2. Instale o utilitário telemetrygen:

go install github.com/open-telemetry/opentelemetry-collector-contrib/cmd/telemetrygen@latest

Esse utilitário pode simular um cliente gerando rastros, métricas e logs.

Gerar e coletar telemetria

3. Inicie o Collector, escutando nas portas 4317 (para OTLP gRPC), 4318 (para OTLP HTTP) e 55679 (para ZPages):

docker run \
  -p 127.0.0.1:4317:4317 \
  -p 127.0.0.1:4318:4318 \
  -p 127.0.0.1:55679:55679 \
  otel/opentelemetry-collector:0.148.0 \
  2>&1 | tee collector-output.txt # Opcionalmente use tee para facilitar buscas posteriores

4. Em uma janela de terminal separada, gere alguns rastros de exemplo:

$GOBIN/telemetrygen traces --otlp-insecure --traces 3

Entre as saídas geradas pelo utilitário, você deverá ver uma confirmação de que rastros foram gerados:

2024-01-16T14:33:15.692-0500  INFO  traces/worker.go:99  traces generated  {"worker": 0, "traces": 3}
2024-01-16T14:33:15.692-0500  INFO  traces/traces.go:58  stop the batch span processor

Para facilitar a visualização da saída relevante, você pode filtrá-la:

$GOBIN/telemetrygen traces --otlp-insecure \
  --traces 3 2>&1 | grep -E 'start|traces|stop'

5. No terminal onde o contêiner do Collector está em execução, você deverá ver a atividade de ingestão de rastros semelhante ao que é mostrado no exemplo a seguir:

$ grep -E '^Span|(ID|Name|Kind|time|Status \w+)\s+:' ./collector-output.txt
Span #0
   Trace ID       : f30faffbde5fcf71432f89da1bf7bc14
   Parent ID      : 6f1ff7f9cf4ec1c7
   ID             : 8d1e820c1ac57337
   Name           : okey-dokey
   Kind           : Server
   Start time     : 2024-01-16 14:13:54.585877 +0000 UTC
   End time       : 2024-01-16 14:13:54.586 +0000 UTC
   Status code    : Unset
   Status message :
Span #1
   Trace ID       : f30faffbde5fcf71432f89da1bf7bc14
   Parent ID      :
   ID             : 6f1ff7f9cf4ec1c7
   Name           : lets-go
   Kind           : Client
   Start time     : 2024-01-16 14:13:54.585877 +0000 UTC
   End time       : 2024-01-16 14:13:54.586 +0000 UTC
   Status code    : Unset
   Status message :
...

6. Abra http://localhost:55679/debug/tracez e selecione uma das amostras na tabela para ver os rastros que você acabou de gerar.

7. Quando terminar, encerre o contêiner do Collector, por exemplo, usando Control-C.

Próximos passos

Neste tutorial, você iniciou o OpenTelemetry Collector e enviou telemetria para ele. Como próximos passos, considere:

• Explorar diferentes maneiras de instalar o Collector.
• Aprender sobre os diferentes modos do Collector em Deployment Methods.
• Familiarizar-se com os arquivos e a estrutura de configuração do Collector.
• Explorar os componentes disponíveis no registro.
• Aprender a construir um Collector personalizado com o OpenTelemetry Collector Builder (OCB).