Java

SDK de Java para ClickStack - la pila de observabilidad de ClickHouse

ClickStack usa el estándar OpenTelemetry para recopilar datos de telemetría (logs y trazas). Las trazas se generan automáticamente mediante instrumentación automática, por lo que no se requiere instrumentación manual para aprovecharlas.

Esta guía integra:

✅ Logs

✅ Métricas

✅ Trazas

​

Primeros pasos

Actualmente, la integración es compatible exclusivamente con Java 8+

​

Descargar el agente de Java de OpenTelemetry

Descarga opentelemetry-javaagent.jar y coloca el archivo JAR en el directorio que prefieras. El archivo JAR contiene el agente y las bibliotecas de instrumentación. También puedes usar el siguiente comando para descargar el agente:

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

​

Configurar variables de entorno

Después, tendrás que configurar las siguientes variables de entorno en tu shell para enviar telemetría a ClickStack a través del 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 de código abierto

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>'

La variable de entorno OTEL_SERVICE_NAME se usa para identificar tu servicio en la aplicación HyperDX; puede ser cualquier nombre que quieras.

La variable de entorno OTEL_EXPORTER_OTLP_HEADERS contiene la clave de API disponible en la aplicación HyperDX, en Team Settings → API Keys.

​

Ejecuta la aplicación con el agente de Java de OpenTelemetry

java -jar target/<APPLICATION_JAR_FILE>

Obtén más información sobre la instrumentación de Java con OpenTelemetry aquí: https://opentelemetry.io/docs/instrumentation/java/