Java

SDK Java para ClickStack - a stack de observabilidade da ClickHouse

O ClickStack usa o padrão OpenTelemetry para coletar dados de telemetria (logs e traces). Os traces são gerados automaticamente com instrumentação automática, então a instrumentação manual não é necessária para aproveitar o tracing.

Este guia integra:

✅ Logs

✅ Métricas

✅ Traces

​

Primeiros passos

No momento, a integração é compatível apenas com Java 8+

​

Baixe o agente Java do OpenTelemetry

Baixe opentelemetry-javaagent.jar e coloque o JAR no diretório de sua preferência. O arquivo JAR contém o agente e as bibliotecas de instrumentação. Você também pode usar o comando a seguir para baixar o agente:

curl -L -O https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar

​

Configure variáveis de ambiente

Em seguida, você precisará configurar as seguintes variáveis de ambiente no shell para enviar telemetria ao ClickStack por meio do OpenTelemetry Collector:

Managed ClickStack

export JAVA_TOOL_OPTIONS="-javaagent:PATH/TO/opentelemetry-javaagent.jar" \
OTEL_EXPORTER_OTLP_ENDPOINT=https://your-otel-collector:4318 \
OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \
OTEL_LOGS_EXPORTER=otlp \
OTEL_SERVICE_NAME='<NAME_OF_YOUR_APP_OR_SERVICE>'

ClickStack Open Source

export JAVA_TOOL_OPTIONS="-javaagent:PATH/TO/opentelemetry-javaagent.jar" \
OTEL_EXPORTER_OTLP_ENDPOINT=https://your-otel-collector:4318 \
OTEL_EXPORTER_OTLP_HEADERS='authorization=<YOUR_INGESTION_API_KEY>' \
OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \
OTEL_LOGS_EXPORTER=otlp \
OTEL_SERVICE_NAME='<NAME_OF_YOUR_APP_OR_SERVICE>'

A variável de ambiente OTEL_SERVICE_NAME é usada para identificar seu serviço no aplicativo HyperDX; ela pode ter qualquer nome.

A variável de ambiente OTEL_EXPORTER_OTLP_HEADERS contém a chave de API disponível no aplicativo HyperDX em Team Settings → API Keys.

​

Inicie a aplicação com o agente Java do OpenTelemetry

java -jar target/<APPLICATION_JAR_FILE>

Leia mais sobre a instrumentação Java do OpenTelemetry aqui: https://opentelemetry.io/docs/instrumentation/java/