Java

ClickStack 向け Java SDK - ClickHouse オブザーバビリティ スタック

ClickStack は、テレメトリーデータ (ログと トレース) の収集に OpenTelemetry 標準を使用します。トレースは自動インストルメンテーションによって自動生成されるため、 トレーシングを活用するうえで手動の インストルメンテーションは必要ありません。

このガイドで統合する項目:

✅ ログ

✅ メトリクス

✅ トレース

​

はじめに

現在、このインテグレーションは Java 8+ にのみ対応しています

​

OpenTelemetry Java agent をダウンロードする

opentelemetry-javaagent.jar をダウンロードし、任意のディレクトリに JAR ファイルを配置します。この JAR ファイルには、エージェント とインストルメンテーションライブラリが含まれています。次のコマンドを使って エージェントをダウンロードすることもできます。

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

​

環境変数を設定する

次に、OpenTelemetry Collector 経由でテレメトリーを ClickStack に送信するため、シェルで以下の環境変数を設定する必要があります。

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

OTEL_SERVICE_NAME 環境変数は、HyperDX アプリでサービスを識別するために使用されます。値には任意の名前を指定できます。

OTEL_EXPORTER_OTLP_HEADERS 環境変数には、HyperDX アプリの Team Settings → API Keys で確認できる APIキーが含まれます。

​

OpenTelemetry Java agentを使用してアプリケーションを実行する

java -jar target/<APPLICATION_JAR_FILE>

Java OpenTelemetry インストルメンテーションの詳細は、こちらをご覧ください: https://opentelemetry.io/docs/instrumentation/java/