Java アプリケーションのトレース

Docs > APM > アプリケーションインスツルメンテーション > Add the Datadog SDK > Java アプリケーションのトレース

互換性要件

最新の Java トレーサーは、バージョン 8 以降のすべての JVM をサポートしています。バージョン 8 より前の JVM の詳細については、対応する JVM ランタイムをご覧ください。

Datadog の Java バージョンとフレームワークのサポート一覧 (レガシーバージョンとメンテナンスバージョンを含む) については、互換性要件ページをご覧ください。

はじめに

作業を始める前に、Agent のインストールと構成が済んでいることを確認してください。

アプリケーションをインスツルメントする

Datadog Agent をインストールして構成した後、次の手順として、アプリケーションに SDK を直接追加し、そのアプリケーションをインスツルメントします。互換性情報の詳細を確認してください。

アプリケーションのトレースを開始するには

最新のトレーサークラスファイルが含まれる dd-java-agent.jar を、Datadog ユーザーがアクセスできるフォルダにダウンロードします。

wget -O dd-java-agent.jar 'https://dtdg.co/latest-java-tracer'

curl -Lo dd-java-agent.jar 'https://dtdg.co/latest-java-tracer'

ADD 'https://dtdg.co/latest-java-tracer' dd-java-agent.jar

注: 特定のメジャーバージョンの最新ビルドをダウンロードするには、代わりに https://dtdg.co/java-tracer-vX リンクを使用してください。X は、目的のメジャーバージョンです。たとえば、バージョン 1 の最新ビルドの場合は、https://dtdg.co/java-tracer-v1 を使用します。マイナーバージョン番号は含めないでください。または、特定のバージョンについては、Datadog の Maven リポジトリを参照してください。

注: リリース候補バージョンは、GitHub の DataDog/dd-trace-java リリースで入手可能です。これらのバージョンにはバージョン番号に「RC」が含まれ、実稼働環境以外でのテストに推奨されます。GitHub のリリース通知を購読すると、新しいリリース候補がテスト可能になったときに通知されます。リリース候補で問題が発生した場合は、Datadog サポートまでご連絡ください。

IDE、Maven または Gradle のアプリケーションスクリプト、または java -jar コマンドから、Continuous Profiler、デプロイ追跡、ログインジェクション (Datadog にログを送信している場合) を有効にしてアプリを実行するには、-javaagent JVM 引数と、該当する構成オプションを追加します。
```
java -javaagent:/path/to/dd-java-agent.jar -Ddd.profiling.enabled=true -Ddd.logs.injection=true -Ddd.service=my-app -Ddd.env=staging -Ddd.version=1.0 -jar path/to/your/app.jar
```
Note: If you have a strong need to reduce the size of your image and omit modules, you can use the jdeps command to identify dependencies. However, required modules can change over time, so do this at your own risk.
Note: When running the SDK with Java 24+, you may see warnings related to JNI native access. Suppress these warnings by adding the --enable-native-access=ALL-UNNAMED flag. See JEP 472 for more details.
プロファイリングを有効にすると、APM バンドルによっては請求額に影響が出る場合があります。詳細については、料金ページを参照してください。

環境変数	システムプロパティ	説明
`DD_ENV`	`dd.env`	ご使用のアプリケーション環境 (`production`、`staging` など)
`DD_LOGS_INJECTION`	`dd.logs.injection`	Datadog トレースとスパン ID の自動 MDC キー挿入を有効にします。詳細は、高度な使用方法を参照してください。バージョン 1.18.3 以降、このサービスが実行される場所で Agent Remote Configuration が有効になっている場合は、Software Catalog UI で `DD_LOGS_INJECTION` を設定できます。
`DD_PROFILING_ENABLED`	`dd.profiling.enabled`	Continuous Profiler の有効化
`DD_SERVICE`	`dd.service`	同じジョブを実行する一連のプロセスの名前。アプリケーションの統計情報をグループ化するために使用されます。
`DD_TRACE_SAMPLE_RATE`	`dd.trace.sample.rate`	全サービスのトレースルートでサンプリングレートを設定します。バージョン 1.18.3 以降、このサービスが実行される場所で Agent Remote Configuration が有効になっている場合は、Software Catalog UI で `DD_TRACE_SAMPLE_RATE` を設定できます。
`DD_TRACE_SAMPLING_RULES`	`dd.trace.sampling.rules`	指定したルールに合致するサービスのトレースのルートでサンプリングレートを設定します。
`DD_VERSION`	`dd.version`	アプリケーションのバージョン (例: `2.5`、`202003181415`、または `1.3-alpha`)

その他の構成オプションは、以下で説明します。

JVM への Java SDK の追加

アプリケーションサーバーのドキュメントを参照して、-javaagent とほかの JVM 引数を渡すための適切な方法を確認してください。一般的に使用されるフレームワークの手順は次のとおりです。

アプリの名前が my_app.jar の場合、以下を含む my_app.conf を作成します。

JAVA_OPTS=-javaagent:/path/to/dd-java-agent.jar

詳細については、Spring Boot のドキュメントを参照してください。

Linux

Linux で Tomcat を実行する際にトレースを有効にするには、次のようにします。

Tomcat の起動スクリプトファイル (例: setenv.sh) を開きます。

setenv.sh に次の内容を追加します。

CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/dd-java-agent.jar"

Windows (Windows サービスとしての Tomcat)

Windows サービスとして Tomcat を実行する際にトレースを有効にするには、次のようにします。

Tomcat プロジェクトフォルダの ./bin ディレクトリにあるメンテナンスユーティリティ “tomcat@VERSION_[email protected]” を開きます。
[Java] タブに移動し、Java Options に次の内容を追加します。

-javaagent:C:\path\to\dd-java-agent.jar

Tomcat サービスを再起動して、変更を有効にします。

スタンドアロンモードの場合:
standalone.conf の末尾に次の行を追加します。

JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/dd-java-agent.jar"

Windows でスタンドアロンモードを使用している場合は、standalone.conf.bat の末尾に次の行を追加します。

set "JAVA_OPTS=%JAVA_OPTS% -javaagent:X:/path/to/dd-java-agent.jar"

ドメインモードの場合:
domain.xml ファイルの server-groups.server-group.jvm.jvm-options タグの下に、次の行を追加します。

<option value="-javaagent:/path/to/dd-java-agent.jar"/>

詳細については、JBoss のドキュメントを参照してください。

jetty.sh を使用して Jetty をサービスとして起動する場合は、次の内容を追加します。

JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/path/to/dd-java-agent.jar"

start.ini を使用して Jetty を起動する場合は、次の行を追加します (--exec の下に追加します。--exec 行がない場合は、追加してください)。

-javaagent:/path/to/dd-java-agent.jar

管理コンソールで、次のようにします。

[Servers] (サーバー) を選択します。[Server Type] (サーバータイプ) で、[WebSphere application servers] (WebSphere アプリケーションサーバー) を選択し、対象のサーバーを選択します。
[Java and Process Management] (Java およびプロセス管理) > [Process Definition] (プロセス定義) を選択します。
[Additional Properties] (追加プロパティ) セクションで、[Java Virtual Machine] (Java 仮想マシン) をクリックします。
[Generic JVM arguments] (汎用 JVM 引数) テキストフィールドに、次のように入力します。

-javaagent:/path/to/dd-java-agent.jar

詳細とオプションについては、WebSphere のドキュメントを参照してください。

注

java -jar コマンドに -javaagent 引数を追加する場合は、-jar 引数の_前_に JVM オプションとして追加してください。アプリケーションの引数として追加しないでください。たとえば、次のようにします。
```
java -javaagent:/path/to/dd-java-agent.jar -jar my_app.jar
```
For more information, see the Oracle documentation.
クラスパスに dd-java-agent を追加しないでください。予期しない動作が発生する可能性があります。