はじめに

セットアップ

1. opentelemetry-java-instrumentationリポジトリの Releasesからopentelemetry-javaagent.jarをダウンロードし、任意のディレクトリに配置してください。この JAR ファイルにはエージェントと計装ライブラリが含まれています。
2. JVM の起動引数に -javaagent:path/to/opentelemetry-javaagent.jar とその他の設定を追加し、アプリケーションを起動します。

   • 起動コマンドに直接指定する場合。

     java -javaagent:path/to/opentelemetry-javaagent.jar -Dotel.service.name=your-service-name -jar myapp.jar
     

   • JAVA_TOOL_OPTIONS やその他の環境変数を経由する場合。

     export JAVA_TOOL_OPTIONS="-javaagent:path/to/opentelemetry-javaagent.jar"
     export OTEL_SERVICE_NAME="your-service-name"
     java -jar myapp.jar
     

宣言的設定

宣言的設定では、環境変数やシステムプロパティのかわりに YAML ファイルを使用します。 多くの設定オプションを指定する場合や、環境変数やシステムプロパティでは利用できない設定オプションを使用したい場合に便利です。

詳細については、宣言的設定ページを参照してください。

エージェントの設定

エージェントは高度にカスタマイズ可能です。

一つの選択肢は、設定プロパティを-Dフラグを通じて渡すことです。 この例では、サービス名とトレース用の Zipkin エクスポーターを設定しています。

java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.service.name=your-service-name \
     -Dotel.traces.exporter=zipkin \
     -jar myapp.jar

環境変数を使用してエージェントを設定することもできます。

OTEL_SERVICE_NAME=your-service-name \
OTEL_TRACES_EXPORTER=zipkin \
java -javaagent:path/to/opentelemetry-javaagent.jar \
     -jar myapp.jar

Javaプロパティファイルを指定して、そこから設定値を読み込むこともできます。

java -javaagent:path/to/opentelemetry-javaagent.jar \
     -Dotel.javaagent.configuration-file=path/to/properties/file.properties \
     -jar myapp.jar

または、以下のように設定もできます。

OTEL_JAVAAGENT_CONFIGURATION_FILE=path/to/properties/file.properties \
java -javaagent:path/to/opentelemetry-javaagent.jar \
     -jar myapp.jar

すべての設定オプションについては、エージェント設定を参照してください。

サポートされているライブラリ、フレームワーク、アプリケーションサービス、JVM

Java エージェントには、多くの人気なコンポーネント用の計装ライブラリが同梱されています。 すべてのリストについては、サポートされているライブラリ、フレームワーク、アプリケーションサービス、JVMを参照してください。

トラブルシューティング

次のステップ

アプリケーションやサービスの自動計装を設定した後、選択したメソッドにアノテーションを付けたり、カスタムテレメトリーデータを収集するための手動計装を追加できます。