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

インストールと利用開始

何らかの言語で記述されたアプリケーションのトレースを始めるには、まず Datadog Agent をインストール、構成し、Docker アプリケーションのトレースまたは Kubernetes アプリケーションのトレースに関する追加ドキュメントを確認します。

次に、エージェントクラスファイルが含まれる dd-java-agent.jar をダウンロードします:

wget -O dd-java-agent.jar 'https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.datadoghq&a=dd-java-agent&v=LATEST'

最後に、アプリケーションの起動時に IDE、Maven または Gradle アプリケーションスクリプト、または java -jar コマンドに次の JVM 引数を追加します:

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

注:

• -javaagent は -jar ファイルより前に実行され、アプリケーション引数ではなく JVM オプションとして追加される必要があります。詳しくは、Oracle ドキュメントを参照してください。

• dd-trace-java の成果物 (dd-java-agent.jar、dd-trace-api.jar、dd-trace-ot.jar) は、すべての JVM ベース言語、つまり Scala、Groovy、Kotlin、Clojure などをサポートします。特定のフレームワークのサポートが必要な場合は、オープンソースの貢献を行うことを検討してください。

自動でデータと収集

Java の自動インスツルメンテーションは、JVM によって提供される java-agent インスツルメンテーション機能を使用します。java-agent が登録されている場合、これにはロード時間にクラスファイルを変更する能力があります。 java-agent は Byte Buddy フレームワークを使ってインスツルメンテーションに対して定義されたクラスを見つけ、必要に応じてこのクラスバイトを変更します。

インスツルメンテーションの由来は自動インスツルメンテーション、OpenTracing api、または両者の混合になる場合があります。一般的に、インスツルメンテーションは次の情報を取得します:

• OpenTracing api からタイムスタンプが提供されない限り、JVM のナノタイムクロックを使ってタイミング時間が取得されます
• キー/値タグペア
• アプリケーションによって処理されていないエラーとスタックトレース
• システムを通過するトレース (リクエスト) の合計数

互換性

Datadog は、Oracle JDK と OpenJDK の両方の Java JRE 1.7 以上を公式にサポートしています。Datadog は Java のアーリーアクセスバージョンを公式にサポートしていません。

インテグレーション

大半のインテグレーションはデフォルトで有効になっています。次の設定により、デフォルトを無効に変更できます。

• システムプロパティ: -Ddd.integrations.enabled=false
• 環境変数: DD_INTEGRATIONS_ENABLED=false

インテグレーション箱別に有効または無効にできます (上記のデフォルトをオーバーライド)。

• システムプロパティ: -Ddd.integration.<インテグレーション名>.enabled=true
• 環境変数: DD_INTEGRATION_<インテグレーション名>_ENABLED=true

(各インテグレーションの名前については以下を参照してください。)

ベータインテグレーションはデフォルトで無効になっていますが、個別に有効にできます。

Web フレームワークの互換性

dd-java-agent には、次のウェブフレームワークの自動トレースのサポートが含まれます。

ウェブフレームワークトレースは次を提供します: HTTP リクエストから応答までの時間、HTTP リクエストのタグ (ステータスコード、メソッドなど)、エラーおよびスタックトレースの取得、ウェブリクエスト内で作成された作業のリンク、分散型トレーシング

注: 多くのアプリケーションサーバーは Servlet 互換でそのインスツルメンテーションによって自動的にカバーされます (Tomcat、Jetty、Websphere、Weblogic など)。 また、Spring Boot のようなフレームワークは、通常サポートされた組み込みアプリケーションサーバーを使うため、本質的に機能します (Tomcat/Jetty/Netty)。

ベータインスツルメンテーションはデフォルトで無効になっています。有効にするには、次のいずれかのコンフィギュレーションを追加します:

• システムプロパティ: -Ddd.integration.<インテグレーション名>.enabled=true
• 環境変数: DD_INTEGRATION_<インテグレーション名>_ENABLED=true

希望するウェブフレームワークが見つかりませんか？Datadog では継続的にサポートを追加しています。サポートが必要な場合は、Datadog サポートにお問い合わせください。

ネットワーキングフレームワークの互換性

dd-java-agent には、次のネットワーキングフレームワークの自動トレースのサポートが含まれます。

ネットワーキングトレースは次を提供します: リクエストから応答までの時間、リクエストのタグ (例: 応答コード)、エラーおよびスタックトレースの取得、分散型トレーシング

希望するネットワーキングフレームワークが見つかりませんか？Datadog では継続的にサポートを追加しています。サポートが必要な場合は、Datadog サポートにお問い合わせください。

データストアの互換性

dd-java-agent には、次のデータベースフレームワーク/ドライバーの自動トレースのサポートが含まれます。

dd-java-agent は、次を含む一般的な JDBC ドライバーとも互換性があります:

• Apache Derby
• Firebird SQL
• H2 データベースエンジン
• HSQLDB
• IBM DB2
• MariaDB
• MSSQL (Microsoft SQL Server)
• MySQL
• Oracle
• Postgres SQL

データストアトレースは次を提供します: リクエストから応答までの時間、クエリ情報 (例: サニタイジングされたクエリ文字列)、エラーおよびスタックトレースの取得

希望するデータストアが見つかりませんか？Datadog では継続的にサポートを追加しています。サポートが必要な場合は、Datadog サポートにお問い合わせください。

他のフレームワークの互換性

dd-java-agent には、次の他のフレームワークの自動トレースのサポートが含まれます。

希望するフレームワークが見つかりませんか？Datadog では継続的にサポートを追加しています。サポートが必要な場合は、Datadog サポートにお問い合わせください。

サポートされていないフレームワークを使ったアプリケーションの可視性を向上させるには、次のことを検討してください:

• カスタムインスツルメンテーションの追加 (OpenTracing または @Trace アノテーション)。
• 将来のリリースに含めるためのインスツルメンテーションによるプルリクエストの送信。
• Datadog サポートへのお問い合わせと機能リクエストの提供。

コンフィギュレーション

トレーサーは、システムプロパティと環境変数を使って次のように構成されます: (上記のインテグレーションセクションのインテグレーション固有の構成を参照してください。)

注:

• 両方に同じキータイプが設定された場合、システムプロパティコンフィギュレーションが優先されます。
• システムプロパティは JVM パラメーターとして使用できます。
• デフォルトで、アプリケーションからの JMX メトリクスは、DogStatsD によりポート 8125 で Datadog Agent に送信されます。DogStatsD がエージェントに対して有効になっていることを確認してください。 Agent をコンテナとして実行している場合は、DD_DOGSTATSD_NON_LOCAL_TRAFFIC が true に設定されていることと、Agent コンテナでポート 8125 が開いていることを確認してください。 Kubernetes の場合は、DogStatsD ポートをホストポートにバインドします。ECS の場合は、タスク定義で適当なフラグを設定します。

構成例:

dd.trace.enabled

システムプロパティとデバッグアプリのモードの例:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.trace.enabled=false -Ddatadog.slf4j.simpleLogger.defaultLogLevel=debug -jar path/to/application.jar

デバッグアプリのログに、Tracing is disabled, not installing instrumentations. と表示されます。

dd.service.name

システムプロパティの例:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.service.name=web-app -jar path/to/application.jar

dd.service.mapping

システムプロパティの例:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.service.name=web-app -Ddd.service.mapping=postgresql:web-app-pg -jar path/to/application.jar

dd.trace.global.tags

スパンと JMX メトリクスにグローバルな env を設定:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.service.name=web-app -Ddd.trace.global.tags=env:dev -jar path/to/application.jar

dd.trace.span.tags

すべてのスパンに project:test を追加する例:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.service.name=web-app -Ddd.trace.global.tags=env:dev -Ddd.trace.span.tags=project:test -jar path/to/application.jar

dd.trace.jmx.tags

JMX メトリクスに custom.type:2 を設定:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.service.name=web-app -Ddd.trace.global.tags=env:dev -Ddd.trace.span.tags=project:test -Ddd.trace.jmx.tags=custom.type:2 -jar path/to/application.jar

dd.trace.methods

システムプロパティの例:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.trace.global.tags=env:dev -Ddd.service.name=web-app -Ddd.trace.methods=notes.app.NotesHelper[customMethod3] -jar path/to/application.jar

dd.trace.db.client.split-by-instance

システムプロパティの例:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.trace.global.tags=env:dev -Ddd.service.name=web-app -Ddd.trace.db.client.split-by-instance=TRUE -jar path/to/application.jar

これで、DB インスタンス 1 である webappdb に、db.instance スパンのメタデータと同じサービス名が付けられます:

これで、DB インスタンス 2 である secondwebappdb に、db.instance スパンのメタデータと同じサービス名が付けられます:

同様に、サービスマップで、1 つの Web アプリが 2 つの異なる Postgres データベースに呼び出しを行っていることがわかります。

dd.http.server.tag.query-string

システムプロパティの例:

java -javaagent:/path/to/dd-java-agent.jar -Ddd.service.name=web-app -Ddd.trace.global.tags=env:dev -Ddd.http.server.tag.query-string=TRUE -jar path/to/application.jar

B3 ヘッダーの抽出と挿入

Datadog APM トレーサーは、分散型トレーシングの B3 ヘッダーの抽出と挿入をサポートしています。

分散したヘッダーの挿入と抽出は、挿入/抽出スタイルを構成することで制御されます。現在、次の 2 つのスタイルがサポートされています:

• Datadog: Datadog
• B3: B3

挿入スタイルは次を使って構成できます:

• システムプロパティ: -Ddd.propagation.style.inject=Datadog,B3
• 環境変数: DD_PROPAGATION_STYLE_INJECT=Datadog,B3

プロパティまたは環境変数の値は、挿入が有効になっているヘッダースタイルのカンマ (またはスペース) 区切りリストです。デフォルトでは、Datadog 挿入スタイルのみが有効になっています。

抽出スタイルは次を使って構成できます:

• システムプロパティ: -Ddd.propagation.style.extract=Datadog,B3
• 環境変数: DD_PROPAGATION_STYLE_EXTRACT=Datadog,B3

プロパティまたは環境変数の値は、抽出が有効になっているヘッダースタイルのカンマ (またはスペース) 区切りリストです。デフォルトでは、Datadog 抽出スタイルのみが有効になっています。

複数の抽出スタイルが有効になっている場合、抽出試行はスタイルの構成順で実行され、最初に成功した抽出値が使われます。

トレースのレポート

Datadog にトレースをレポートすると、次のことが発生します:

• トレースが完了します
• トレースはトレースの非同期キューにプッシュされます
  • キューのサイズには制限があり、設定された上限である 7000 件のトレースを超えて拡大することはありません
  • サイズの上限に達すると、トレースは破棄されます
  • 正確なスループットを実現するため、トレースの合計数が取得されます
• 独立したレポートスレッドで、トレースキューがフラッシュされ、トレースが msgpack 経由でエンコードされ、その後 http 経由で Datadog Agent に送信されます
• キューのフラッシュが 1 秒に 1 回のスケジュールで発生します

Datadog がサポートするライブラリやフレームワークの実際のコード、ドキュメント、使用例を確認したい場合は、インテグレーションセクションの Java アプリケーションの自動インスツルメンテーションされたコンポーネントの全一覧を参照してください。

トレースアノテーション

プロジェクトに dd-trace-api 依存関係を追加します。Maven の場合、次を pom.xml に追加します:

<dependency>
    <groupId>com.datadoghq</groupId>
    <artifactId>dd-trace-api</artifactId>
    <version>{バージョン}</version>
</dependency>

Gradle の場合は、次を追加します:

compile group: 'com.datadoghq', name: 'dd-trace-api', version: {バージョン}

次に @Trace をメソッドに追加して、dd-java-agent.jar での実行時にメソッドがトレースされるようにします。Agent が添付されていない場合は、このアノテーションはアプリケーションに影響しません。

@Trace アノテーションにはデフォルトのオペレーション名 trace.annotation がある一方、トレースされるメソッドにはデフォルトでリソースがあります。

パフォーマンス

Java APM がアプリケーションのオーバーヘッドに与える影響は最小限です:

• Java APM によって維持されるコレクションがメモリで無制限に拡大することはありません
• トレースのレポートによってアプリケーションスレッドがブロックされることはありません
• Java APM は、トレースコレクションとライブラリのインスツルメンテーションのために追加クラスをロードします
• 通常、Java APM による CPU 使用率の上昇は 3% 以内です
• 通常、Java APM による JVM ヒープ使用率の上昇は 3% 以内です

Agent ホスト名の変更

アプリケーションレベルのトレーサーを設定し、以下のカスタム Agent ホスト名にトレースを送信します。

Java Tracing Module が自動的に検索し環境変数の DD_AGENT_HOST や DD_TRACE_AGENT_PORT で初期化します。

java -javaagent:<DD-JAVA-エージェントパス>.jar -jar <アプリケーションパス>.jar

システムプロパティを使うこともできます:

java -javaagent:<DD-JAVA-エージェントパス>.jar \
     -Ddd.agent.host=$DD_AGENT_HOST \
     -Ddd.agent.port=$DD_TRACE_AGENT_PORT \
     -jar <アプリケーションパス>.jar

その他の参考資料

お役に立つドキュメント、リンクや記事:

Datadog Java APM ソースコードGITHUB サービス、リソース、トレースを調査するDOCUMENTATION 高度な使用方法高度な使用方法