Java Tracing Library は、バージョン 7 以降のすべてのプラットフォームですべての JVM をサポートします。Continuous Profiler でトレースを利用するには、OpenJDK 11 以降、Oracle Java 11 以降、ほとんどのベンダー向けの OpenJDK 8 (バージョン8u262 以降)、および Zulu Java 8 以降 (マイナーバージョン 1.8.0_212 以降) がサポートされています。バージョン 8u272 以降、すべてのベンダーがプロファイラーでサポートされるようになります。
Scala (バージョン 2.10.x - 2.13.x)、Groovy、Kotlin、Clojure などのすべての JVM ベースの言語が、Java トレーサーとプロファイラーでサポートされています。サポート対象のライブラリの一覧については、互換性要件ページをご覧ください。
Datadog アプリ内のクイックスタート手順に従って、最高のエクスペリエンスを実現します。例:
service、env、version タグを動的に設定します。もしくは、アプリケーションをトレースする場合は以下の操作を行ってください。
最新の Agent クラスファイルが含まれる dd-java-agent.jar をダウンロードします:
wget -O dd-java-agent.jar https://dtdg.co/latest-java-tracer
トレーサーの特定のバージョンにアクセスするには、Datadog の Maven リポジトリを参照してください。
IDE、Maven または Gradle アプリケーションスクリプト、java -jar コマンドから、継続的プロファイラー、デプロイ追跡、ログ挿入（Datadog へログを送信する場合）、および Tracing without Limits を使用してアプリケーションを実行するには、-javaagent JVM 引数と、該当する以下のコンフィギュレーションオプションを追加します。
java -javaagent:/path/to/dd-java-agent.jar -Ddd.profiling.enabled=true -XX:FlightRecorderOptions=stackdepth=256 -Ddd.logs.injection=true -Ddd.trace.sample.rate=1 -Ddd.service=my-app -Ddd.env=staging -jar path/to/your/app.jar -Ddd.version=1.0
注: プロファイリングを有効にすると、APM のバンドルによっては請求に影響を与える場合があります。詳しくは、料金ページを参照してください。
| 環境変数 | システムプロパティ | 説明 |
|---|---|---|
DD_ENV | dd.env | アプリケーション環境（production、staging など） |
DD_SERVICE | dd.service | 同一のジョブを実行するプロセスセットの名前。アプリケーションの統計のグループ化に使われます。 |
DD_VERSION | dd.version | アプリケーションのバージョン（例: 2.5、202003181415、1.3-alpha など） |
DD_PROFILING_ENABLED | dd.profiling.enabled | 継続的プロファイラーを有効化 |
DD_LOGS_INJECTION | dd.logs.injection | Datadog トレース ID とスパン ID に対する自動 MDC キー挿入を有効にします。詳しくは、高度な使用方法を参照してください。 |
DD_TRACE_SAMPLE_RATE | dd.trace.sample.rate | Tracing Without Limits を有効化 |
追加のコンフィギュレーションオプション は以下で説明されています。
インスツルメントされたアプリケーションからトレースを受信するように Datadog Agent をインストールして構成します。デフォルトでは、Datadog Agent は datadog.yaml ファイルの apm_enabled: true で有効になっており、localhost:8126 でトレーストラフィックをリッスンします。コンテナ化環境の場合、以下のリンクに従って、Datadog Agent 内でトレース収集を有効にします。
メインの datadog.yaml コンフィギュレーションファイルで apm_non_local_traffic: true を設定します
コンテナ化された環境でトレースを受信するように Agent を構成する方法については、それぞれの説明を参照してください。
アプリケーションをインスツルメント化した後、トレースクライアントはデフォルトでトレースを localhost:8126 に送信します。これが正しいホストとポートでない場合は、以下の環境変数を設定して変更します。
DD_AGENT_HOST と DD_TRACE_AGENT_PORT
java -javaagent:<DD-JAVA-AGENT-PATH>.jar -jar <YOUR_APPLICATION_PATH>.jar
システムプロパティを使うこともできます:
java -javaagent:<DD-JAVA-AGENT-PATH>.jar \
-Ddd.agent.host=$DD_AGENT_HOST \
-Ddd.agent.port=$DD_TRACE_AGENT_PORT \
-jar <YOUR_APPLICATION_PATH>.jar
DD_SITE を AWS Lambda で Datadog APM を設定するには、サーバーレス関数のトレースドキュメントを参照してください。
トレースは、Heroku、Cloud Foundry、AWS Elastic Beanstalk、Azure App Services Extension など、他の多くの環境で利用できます。
その他の環境については、その環境のインテグレーションのドキュメントを参照し、セットアップの問題が発生した場合はサポートにお問い合わせください。
アプリケーションサーバーのドキュメントを使用して、-javaagent およびその他の JVM 引数を渡す正しい方法を確認してください。一般的に使用されるフレームワークの手順は次のとおりです。
アプリの名前が my_app.jar の場合は、以下を含む my_app.conf を作成します。
JAVA_OPTS=-javaagent:/path/to/dd-java-agent.jar
詳細については、Spring Boot のドキュメントを参照してください。
Tomcat 起動スクリプトファイル (たとえば、Linux では setenv.sh) を開き、次を追加します。
CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/dd-java-agent.jar"
Windows では、setenv.bat:
set CATALINA_OPTS=%CATALINA_OPTS% -javaagent:"c:\path\to\dd-java-agent.jar"
setenv ファイルが存在しない場合は、Tomcat プロジェクトフォルダーの ./bin ディレクトリで作成します。
standalone.sh の末尾に次の行を追加します。
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"
詳細については、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
管理コンソールで:
-javaagent:/path/to/dd-java-agent.jar
詳細とオプションについては、WebSphere のドキュメントを参照してください。
注
-javaagent 引数を java -jar コマンドに追加する場合は、-jar 引数の_前_に追加する必要があります。つまり、アプリケーション引数としてではなく、JVM オプションとして追加する必要があります。例:
java -javaagent:/path/to/dd-java-agent.jar -jar my_app.jar
詳細については、Oracle のドキュメントを参照してください。
classpath に dd-java-agent を追加しないでください。予期せぬ挙動が生じる場合があります。
Java の自動インスツルメンテーションは、JVM によって提供される java-agent インスツルメンテーション機能を使用します。java-agent が登録されている場合は、ロード時にクラスファイルを変更することができます。
インスツルメンテーションの由来は自動インスツルメンテーション、OpenTracing api、または両者の混合になる場合があります。一般的に、インスツルメンテーションは次の情報を取得します:
以下のすべてのコンフィギュレーションオプションには、同等のシステムプロパティと環境変数があります。 両方に同じキータイプが設定されている場合は、システムプロパティコンフィギュレーションが優先されます。 システムプロパティは、JVM フラグとして設定できます。
注: Java トレーサーのシステムプロパティを使用する場合は、JVM オプションとして読み込まれるように、-jar の前にリストされていることを確認してください。
dd.serviceDD_SERVICEunnamed-java-appdd.tagsDD_TAGSnulllayer:api,team:intakedd.envDD_ENVnonedd.versionDD_VERSIONnulldd.logs.injectionDD_LOGS_INJECTIONfalsedd.trace.configDD_TRACE_CONFIGnull-Ddd.trace.config=<ファイルパス>.properties 経由として、ファイルのサービス名に dd.service=<SERVICE_NAME> を設定して提供することができます。dd.service.mappingDD_SERVICE_MAPPINGnullmysql:my-mysql-service-name-db, postgres:my-postgres-service-name-dbdd.writer.typeDD_WRITER_TYPEDDAgentWriterLoggingWriter で構成すると、トレースがコンソールに書き出されます。dd.agent.hostDD_AGENT_HOSTlocalhostdd.trace.agent.portDD_TRACE_AGENT_PORT8126dd.trace.agent.unix.domain.socketDD_TRACE_AGENT_UNIX_DOMAIN_SOCKETnulldd.trace.agent.urlDD_TRACE_AGENT_URLnullhttp:// (HTTP を使用) もしくは unix:// (Unix ドメインソケットを使用) のいずれかで始まります。この設定は DD_AGENT_HOST および DD_TRACE_AGENT_PORT よりも優先されます。バージョン 0.65 以上で使用可能です。dd.trace.agent.timeoutDD_TRACE_AGENT_TIMEOUT10dd.trace.header.tagsDD_TRACE_HEADER_TAGSnullCASE-insensitive-Header:my-tag-name,User-ID:userIddd.trace.annotationsDD_TRACE_ANNOTATIONScom.some.Trace;io.other.Trace@Trace として処理するメソッドアノテーションのリスト。dd.trace.methodsDD_TRACE_METHODSnull"package.ClassName[method1,method2,...];AnonymousClass$1[call];package.ClassName[*]"@Trace の追加と似ていますが、コードの変更はありません。注: ワイルドカード型メソッドのサポート ([*]) は、コンストラクター、get アクセス操作子、set アクセス操作子、synthetic、toString、等号、ハッシュコード、またはファイナライザーメソッドのコールに対応しません。dd.trace.classes.excludeDD_TRACE_CLASSES_EXCLUDEnullpackage.ClassName,package.ClassName$Nested,package.Foo*,package.other.*dd.trace.partial.flush.min.spansDD_TRACE_PARTIAL_FLUSH_MIN_SPANS1000dd.trace.split-by-tagsDD_TRACE_SPLIT_BY_TAGSnullaws.servicedd.trace.db.client.split-by-instanceDD_TRACE_DB_CLIENT_SPLIT_BY_INSTANCEfalsetrue に設定すると、db スパンにインスタンス名がサービス名として割り当てられますdd.trace.health.metrics.enabledDD_TRACE_HEALTH_METRICS_ENABLEDfalsetrue に設定すると、トレーサーヘルスメトリクスが送信されますdd.trace.health.metrics.statsd.hostDD_TRACE_HEALTH_METRICS_STATSD_HOSTdd.jmxfetch.statsd.host と同じdd.trace.health.metrics.statsd.portDD_TRACE_HEALTH_METRICS_STATSD_PORTdd.jmxfetch.statsd.port と同じdd.http.client.tag.query-stringDD_HTTP_CLIENT_TAG_QUERY_STRINGfalsetrue に設定すると、クエリ文字列パラメーターとフラグメントがウェブクライアントスパンに追加されますdd.http.client.error.statusesDD_HTTP_CLIENT_ERROR_STATUSES400-499dd.http.client.error.statuses=400-403,405,410-499dd.http.server.error.statusesDD_HTTP_SERVER_ERROR_STATUSES500-599dd.http.server.error.statuses=500,502-599dd.http.server.tag.query-stringDD_HTTP_SERVER_TAG_QUERY_STRINGfalsetrue に設定すると、クエリ文字列パラメーターとフラグメントがウェブサーバースパンに追加されますdd.trace.enabledDD_TRACE_ENABLEDtruefalse トレースエージェントが無効の時dd.jmxfetch.enabledDD_JMXFETCH_ENABLEDtruedd.jmxfetch.config.dirDD_JMXFETCH_CONFIG_DIRnull/opt/datadog-agent/etc/conf.dyaml ファイルの instance セクションの jvm_direct:true を探してコンフィギュレーションを変更します。dd.jmxfetch.configDD_JMXFETCH_CONFIGnullactivemq.d/conf.yaml,jmx.d/conf.yamlyaml ファイルの instance セクションの jvm_direct:true を探してコンフィギュレーションを変更します。dd.jmxfetch.check-periodDD_JMXFETCH_CHECK_PERIOD1500dd.jmxfetch.refresh-beans-periodDD_JMXFETCH_REFRESH_BEANS_PERIOD600dd.jmxfetch.statsd.hostDD_JMXFETCH_STATSD_HOSTagent.host と同じunix:///var/datadog-agent/dsd.socketdd.jmxfetch.statsd.portDD_JMXFETCH_STATSD_PORT8125dd.integration.opentracing.enabledDD_INTEGRATION_OPENTRACING_ENABLEDtruedd.hystrix.tags.enabledDD_HYSTRIX_TAGS_ENABLEDfalsedd.trace.servlet.async-timeout.errorDD_TRACE_SERVLET_ASYNC_TIMEOUT_ERRORtruedd.trace.startup.logsDD_TRACE_STARTUP_LOGStruefalse の場合は起動ログの収集が無効化されます。バージョン 0.64 以上で使用可能です。dd.trace.servlet.principal.enabledDD_TRACE_SERVLET_PRINCIPAL_ENABLEDfalsetrue の場合は、ユーザープリンシパルが収集されます。バージョン 0.61 以降で使用可能です。注:
両方に同じキータイプが設定された場合、システムプロパティコンフィギュレーションが優先されます。
システムプロパティは JVM パラメーターとして使用できます。
デフォルトで、アプリケーションからの JMX メトリクスは、DogStatsD によりポート 8125 で Datadog Agent に送信されます。DogStatsD が Agent に対して有効になっていることを確認してください。
DD_DOGSTATSD_NON_LOCAL_TRAFFIC が true に設定されていることと、Agent コンテナでポート 8125 が開いていることを確認してください。インテグレーションを無効にする方法については、インテグレーションの互換性セクションを参照してください。
dd.service.mappingシステムプロパティの例:
java -javaagent:/path/to/dd-java-agent.jar -Ddd.service=web-app -Ddd.service.mapping=postgresql:web-app-pg -jar path/to/application.jar
dd.tagsスパンと JMX メトリクスにグローバルな env を設定:
java -javaagent:/path/to/dd-java-agent.jar -Ddd.service=web-app -Ddd.env=dev -jar path/to/application.jar
dd.trace.span.tagsすべてのスパンに project:test を追加する例:
java -javaagent:/path/to/dd-java-agent.jar -Ddd.service=web-app -Ddd.env=dev -Ddd.trace.span.tags=project:test -jar path/to/application.jar
dd.trace.jmx.tagsJMX メトリクスに custom.type:2 を設定:
java -javaagent:/path/to/dd-java-agent.jar -Ddd.service=web-app -Ddd.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.service=web-app -Ddd.env=dev -Ddd.trace.methods="hello.GreetingController[doSomeStuff,doSomeOtherStuff];hello.Randomizer[randomize]" -jar path/to/application.jar
dd.trace.db.client.split-by-instanceシステムプロパティの例:
java -javaagent:/path/to/dd-java-agent.jar -Ddd.env=dev -Ddd.service=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=web-app -Ddd.env=dev -Ddd.http.server.tag.query-string=TRUE -jar path/to/application.jar
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.jmxfetch.config.dir and dd.jmxfetch.config構成サンプル
DD_JMXFETCH_CONFIG_DIR=<ディレクトリパス> + DD_JMXFETCH_CONFIG=conf.yamlDD_JMXFETCH_CONFIG=<ディレクトリパス>/conf.yamlconf.yaml で以下の内容を使用します。
init_config:
instances:
- jvm_direct: true
port: '<PORT>'
conf:
- include:
bean:
- java.lang:type=MemoryPool,name=Metaspace
attribute:
Usage.used:
metric_type: gauge
alias: sb.usage.used
次の結果が生成されます。
JMX フェッチを使った Java メトリクス収集についての詳細は Java インテグレーションドキュメントを参照してください。
Datadog APM トレーサーは、分散型トレーシングの B3 ヘッダーの抽出と挿入をサポートしています。
分散したヘッダーの挿入と抽出は、挿入/抽出スタイルを構成することで制御されます。現在、次の 2 つのスタイルがサポートされています:
DatadogB3挿入スタイルは次を使って構成できます:
-Ddd.propagation.style.inject=Datadog,B3DD_PROPAGATION_STYLE_INJECT=Datadog,B3プロパティまたは環境変数の値は、挿入が有効になっているヘッダースタイルのカンマ (またはスペース) 区切りリストです。デフォルトでは、Datadog 挿入スタイルのみが有効になっています。
抽出スタイルは次を使って構成できます:
-Ddd.propagation.style.extract=Datadog,B3DD_PROPAGATION_STYLE_EXTRACT=Datadog,B3プロパティまたは環境変数の値は、抽出が有効になっているヘッダースタイルのカンマ (またはスペース) 区切りリストです。デフォルトでは、Datadog 抽出スタイルのみが有効になっています。
複数の抽出スタイルが有効になっている場合、抽出試行はスタイルの構成順で実行され、最初に成功した抽出値が使われます。
Datadog にトレースをレポートすると、次のことが発生します:
Datadog がサポートするライブラリやフレームワークの実際のコード、ドキュメント、使用例を確認したい場合は、インテグレーションセクションの Java アプリケーションの自動インスツルメンテーションされたコンポーネントの全一覧を参照してください。
プロジェクトに dd-trace-api 依存関係を追加します。Maven の場合、次を pom.xml に追加します:
<dependency>
<groupId>com.datadoghq</groupId>
<artifactId>dd-trace-api</artifactId>
<version>{バージョン}</version>
</dependency>
Gradle の場合は、次を追加します:
implementation group: 'com.datadoghq', name: 'dd-trace-api', version: {バージョン}
次に @Trace をメソッドに追加して、dd-java-agent.jar での実行時にメソッドがトレースされるようにします。Agent が添付されていない場合は、このアノテーションはアプリケーションに影響しません。
@Trace アノテーションにはデフォルトのオペレーション名 trace.annotation がある一方、トレースされるメソッドにはデフォルトでリソースがあります。
Java APM がアプリケーションのオーバーヘッドに与える影響は最小限です:
お役に立つドキュメント、リンクや記事:
