設定

詳細情報

このページでは、Java エージェントに設定を渡すさまざまな方法について説明します。設定オプションそのものについては、SDK の設定を参照してください。

エージェントの設定

エージェントは、以下のソースの1つまたは複数から設定を読み込むことができます（優先度の高い順）。

特定の環境では、環境変数を通じて設定を行うことが好まれます。システムプロパティで設定できるすべての設定は、環境変数でも設定できます。以下の設定の多くは両方の形式の例を示していますが、示していないものについては、以下の手順で目的のシステムプロパティに対応する環境変数名を特定できます。

たとえば、otel.instrumentation.common.default-enabled は OTEL_INSTRUMENTATION_COMMON_DEFAULT_ENABLED に変換されます。

以下のプロパティを設定して、エージェント設定ファイルのパスを指定できます。

System property: otel.javaagent.configuration-file

Environment variable: OTEL_JAVAAGENT_CONFIGURATION_FILE

Description: エージェント設定を含む有効な Java プロパティファイルのパス。

以下のプロパティを設定して、エクステンションを有効にできます。

System property: otel.javaagent.extensions

Environment variable: OTEL_JAVAAGENT_EXTENSIONS

Description: エクステンション jar ファイルまたは jar ファイルを含むフォルダーのパス。フォルダーを指定した場合、そのフォルダー内のすべての jar ファイルが個別の独立したエクステンションとして扱われます。

以下のプロパティを設定して、エージェントのログ出力を設定できます。

System property: otel.javaagent.logging

Environment variable: OTEL_JAVAAGENT_LOGGING

Description: Java エージェントのログモード。以下の3つのモードがサポートされています。

simple: エージェントは標準エラーストリームを使用してログを出力します。 INFO 以上のログのみが出力されます。これはデフォルトの Java エージェントログモードです。
none: エージェントは何もログに記録しません。バージョン情報も含まれません。
application: エージェントは自身のログを計装対象アプリケーションの slf4j ロガーにリダイレクトしようとします。これは、複数のクラスローダーを使用しないシンプルな単一 jar アプリケーションに最適です。 Spring Boot アプリケーションもサポートされています。 Java エージェントの出力ログは、計装対象アプリケーションのログ設定（たとえば logback.xml や log4j2.xml）を使用してさらに設定できます。 本番環境で実行する前に、このモードがアプリケーションで正しく動作することを必ずテストしてください。

SDK の自動設定モジュールは、エージェントの基本設定に使用されます。エクスポートやサンプリングの設定などについては、ドキュメントを参照してください。

重要

SDK の自動設定とは異なり、バージョン 2.0 以降の Java エージェントと OpenTelemetry Spring Boot スターターは、デフォルトプロトコルとして grpc ではなく http/protobuf を使用します。

SDK の自動設定によるリソース設定に加えて、デフォルトで無効になっている追加のリソースプロバイダーを有効にできます。

System property: otel.resource.providers.aws.enabled

Environment variable: OTEL_RESOURCE_PROVIDERS_AWS_ENABLED

Default: false
Description: AWS Resource Provider を有効にします。

System property: otel.resource.providers.gcp.enabled

Environment variable: OTEL_RESOURCE_PROVIDERS_GCP_ENABLED

Default: false
Description: GCP Resource Provider を有効にします。

System property: otel.resource.providers.azure.enabled

Environment variable: OTEL_RESOURCE_PROVIDERS_AZURE_ENABLED

Default: false
Description: Azure Resource Provider を有効にします。

このページは役に立ちましたか?

Thank you. Your feedback is appreciated!

Please let us know how we can improve this page. Your feedback is appreciated!