Docs » Splunk Observability Cloud でサポートされているインテグレーション » バックエンドアプリケーションをインストルメンテーションして、スパンを Splunk APM に送信する » Splunk Observability Cloud 用 Java アプリケーションのインストルメンテーション » Splunk Observability Cloud 用の Java エージェントを設定する

Splunk Observability Cloud 用の Java エージェントを設定する 🔗

Splunk Distribution of OpenTelemetry Java から、ほとんどのインストルメンテーションのニーズに合うように Java エージェントを設定できます。ほとんどの場合、基本的な設定を変更するだけで十分です。より高度な設定も可能です。

以下のセクションでは、Splunk Distribution of OpenTelemetry Java 独自の新機能を有効にするオプションを含め、Java 仮想マシン (JVM) エージェントを構成するために利用可能なすべての設定について説明します。

設定方法 🔗

エージェントの設定は2つの方法で変更できます：

  • 環境変数を設定します。例：

    export OTEL_SERVICE_NAME=my-java-app

  • システム・プロパティをランタイム・パラメータとして追加します。例：

    java -javaagent:./splunk-otel-javaagent.jar \
-Dotel.service.name=<my-java-app> \
-jar <myapp>.jar

環境変数は、OpenTelemetry エージェントを設定するための望ましい方法です。システムプロパティを指定すると、既存の環境変数を上書きします。

一般設定 🔗

以下の設定は、Splunk Distribution of OpenTelemetry Java 固有のものです：

トレースサンプリングの例 🔗

次の例は、rules traces sampler を使用して、/healthcheck エンドポイントを監視から除外する方法を示しています：

export OTEL_TRACES_SAMPLER=rules
export OTEL_TRACES_SAMPLER_ARG=drop=/healthcheck;fallback=parentbased_always_on

除外されたエンドポイントを呼び出した結果として起こるダウンストリームサービスへのリクエストもすべて除外されます。

Considerations on trace propagation 🔗

旧バージョンの Splunk Distribution of OpenTelemetry Java または SignalFx Java Agent との後方互換性を保つには、b3multi トレースプロパゲータを使用してください：

export OTEL_PROPAGATORS=b3multi

Instrumentation configuration 🔗

The following settings control the instrumentation, including tracing and :

エクスポーターの設定 🔗

以下の設定は、トレースエクスポーターとそのエンドポイントをコントロールします：

The Splunk Distribution of OpenTelemetry Java uses the OTLP http/protobuf span exporter by default. To send data directly to Splunk Observability Cloud, see Splunk Observability Cloud に直接データを送信する.

AlwaysOn Profilingの Java 設定 🔗

以下の設定は、Java エージェントの AlwaysOn Profiling機能を制御します：

AlwaysOn Profilingの詳細については、Splunk APMのAlwaysOn Profilingの概要 を参照してください。

サーバートレース情報 🔗

モバイルおよびウェブアプリケーションからのリアルユーザーモニタリング（RUM）リクエストとサーバートレース・データを接続するために、トレース・レスポンス・ヘッダーがデフォルトで有効になっています。インストルメンテーションは、HTTP レスポンスに以下のレスポンス・ヘッダーを追加します：

Access-Control-Expose-Headers: Server-Timing
Server-Timing: traceparent;desc="00-<serverTraceId>-<serverSpanId>-01"

Server-Timing ヘッダーは、traceId と spanId パラメータを traceparent 形式で含みます。詳しくは、W3CウェブサイトのServer-Timingとtraceparentのドキュメントを参照してください。

以下のサーバー・フレームワークとライブラリは、Server-Timing の情報を追加します：

  • Servlet API バージョン 2.2 から 4.X。

  • Nettyバージョン3.8から4.0。

注釈

トレース・レスポンス・ヘッダーを無効にする必要がある場合は、SPLUNK_TRACE_RESPONSE_HEADER_ENABLED を false に設定します。

その他の設定 🔗

環境変数

説明

OTEL_JAVAAGENT_ENABLED

Globally activates the Java agent automatic instrumentation. The default value is true. Useful for deactivating automatic discovery in testing scenarios or pipelines.

System property: otel.javaagent.enabled.

This page was last updated on 2024年05月16日.