Java

Java SDK для ClickStack — стека обсервабилити ClickHouse

ClickStack использует стандарт OpenTelemetry для сбора телеметрии (журналов и трейсов). Трейсы генерируются автоматически с помощью автоматической инструментации, поэтому ручная инструментация не нужна, чтобы получить пользу от трассировки.

В этом руководстве рассматриваются:

✅ Журналы

✅ Метрики

✅ Трейсы

​

Начало работы

В настоящее время интеграция совместима только с Java 8+

​

Скачайте Java-агент OpenTelemetry

Скачайте opentelemetry-javaagent.jar и поместите JAR-файл в удобный для вас каталог. JAR-файл содержит агент и библиотеки инструментирования. Агент также можно скачать с помощью следующей команды:

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

​

Настройте переменные окружения

После этого вам нужно задать в оболочке следующие переменные окружения, чтобы передавать телеметрию в ClickStack через OpenTelemetry Collector:

Управляемый 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 с открытым исходным кодом

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

Переменная окружения OTEL_SERVICE_NAME используется для идентификации вашего сервиса в приложении HyperDX; вы можете указать для неё любое имя.

Переменная окружения OTEL_EXPORTER_OTLP_HEADERS содержит ключ API, доступный в приложении HyperDX в разделе Team Settings → API Keys.

​

Запустите приложение с Java-агентом OpenTelemetry

java -jar target/<APPLICATION_JAR_FILE>

Подробнее об инструментировании Java с помощью OpenTelemetry читайте здесь: https://opentelemetry.io/docs/instrumentation/java/