概要

ランタイムメトリクスは、アプリケーションのメモリ使用量、ガーベジコレクション、並列処理をモニターします。Datadog SDK は、サポートされている環境のこれらのメトリクスを自動的に収集し、Datadog Agent に送信します。

これらのメトリクスは、ボトルネックを特定し、パフォーマンスの問題をトラブルシューティングし、リソースの利用を最適化する上で役立ちます。ランタイムメトリクスがトレースやログと共に表示されるため、アプリケーションの健全性とパフォーマンスを包括的に把握できます。

アプリケーションを Datadog のトレースライブラリではなく OpenTelemetry で計測する場合は、設定の手順について OpenTelemetry ランタイムメトリクス を参照してください。

互換性

ランタイムメトリクスは、いくつかのプログラミング言語とランタイムで利用可能ですが、サポートレベルと構成オプションは異なります。

net localgroup "Performance Monitor Users" "IIS APPPOOL\DefaultAppPool" /add

セットアップ手順

ランタイムメトリクスをセットアップするには、Datadog Agent とユーザーのアプリケーションの両方を構成する必要があります。

1. Datadog Agent を構成する

Agent 用の DogStatsD を有効化します。デフォルトでは、Datadog Agent はポート 8125 を介して UDP を使用してメトリクスを取り込むように構成されています。

コンテナ固有の構成

Agent をコンテナ化環境で実行する場合、追加の構成が必要です。

1. DogStatsD の非ローカルトラフィックが有効になっていることを確認してください。この設定はデフォルトで有効になっています。過去に無効化した場合は、メインの datadog.yaml 構成ファイル で dogstatsd_non_local_traffic: true を設定するか、環境変数 DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true を設定します。
2. 以下のコンテナ固有のセットアップ手順に従ってください。

3. Datadog Agent でDD_SITE を設定します。 Datadog Agent が確実に正しい Datadog の場所にデータを送信するためです。

2. ユーザーのアプリケーションを構成する

環境変数を使用してユーザーのアプリケーションのランタイムメトリクスを構成します。一部の言語では、ランタイムメトリクスをコードで直接に構成することもサポートされています。

環境変数

ユーザーのアプリケーション内のランタイムメトリクスを設定するために、以下の環境変数を使用してください。

DD_RUNTIME_METRICS_ENABLED

デフォルト: Java と .NET 6 以降 (v3.40.0 以降) の場合は true、他のすべての言語とランタイムの場合は false です。
説明: ランタイムメトリクスの収集を有効化します。メトリクスは、インスツルメントされたアプリケーションに対して構成され、Datadog Agent に送信されます。

DD_RUNTIME_METRICS_RUNTIME_ID_ENABLED

デフォルト: Java の場合は true、Node.js、Ruby、Python の場合は false です。.NET と Go の場合は存在せず、runtime_id は常に報告されます。
説明: 強化されたランタイムメトリクスを有効化し、各メトリクスに runtime_id タグを付加します。runtime_id はアプリケーションのプロセス識別子を表し、ランタイムメトリクスを実行中の各アプリケーションと直接関連付けることができるようにします。

DD_AGENT_HOST

デフォルト: localhost
説明: SDK のメトリクス送信用にホストのアドレスを設定します。ホスト名または IP アドレスで指定できます。

DD_DOGSTATSD_PORT

デフォルト: 8125
説明: SDK のメトリクス送信用のポートを設定します。

DD_RUNTIME_METRICS_DIAGNOSTICS_METRICS_API_ENABLED

デフォルト: .NET 8 以降 (DD_RUNTIME_METRICS_ENABLED が明示的に設定されていない場合は .NET 6/7) でトレーサー v3.40.0 以降を開始する場合はtrue、それ以外の場合は false です。
説明: .NET 6 以降で利用可能です。これは、.NET トレーサーがEventListener ベースのコレクターの代わりに新しい System.Diagnostics.Metrics API を使用してメトリクスを収集するかどうかをコントロールします。

コードベースの構成

環境変数に加えて、一部の言語ではランタイムメトリクスをコードで直接に構成することがサポートされています。

from ddtrace.runtime import RuntimeMetrics
RuntimeMetrics.enable()

# config/initializers/datadog.rb
require 'datadog/statsd'
require 'datadog' # Use 'ddtrace' if you're using v1.x

Datadog.configure do |c|
  c.runtime_metrics.enabled = true

  # Optionally, you can configure the DogStatsD instance used for sending runtime metrics.
  # DogStatsD is automatically configured with default settings if `dogstatsd-ruby` is available.
  # You can configure with host and port of Datadog agent; defaults to 'localhost:8125'.
  c.runtime_metrics.statsd = Datadog::Statsd.new
end

// Basic configuration
tracer.Start(tracer.WithRuntimeMetrics())

// With custom DogStatsD address
tracer.Start(
  tracer.WithRuntimeMetrics(),
  tracer.WithDogstatsdAddr("custom-host:8125")
)

const tracer = require('dd-trace').init({
  // Other tracer options...
  runtimeMetrics: true
})

ダッシュボード

セットアップが完了したら、以下の場所でランタイムメトリクスを表示できます。

• インスツルメントされたサービスの詳細ページ
• フレームグラフのメトリクスタブ
• デフォルトのランタイムダッシュボード

トラブルシューティング

• フレームグラフ内でランタイムメトリクスを関連付けるには、環境全体で env タグ (大文字と小文字を区別) が設定され、一致していることを確認してください。
• Fargate 使用時にサービスページにランタイムメトリクスが表示されるようにするには、Agent タスクに DD_DOGSTATSD_TAGS が設定されていて、構成された env タグがインスツルメントされたサービスの env と一致することを確認します。

収集データ

サポートされている言語はそれぞれ、メモリ使用量、ガーベジコレクション、CPU 使用率、その他のパフォーマンス指標に関するインサイトを提供する一連のランタイムメトリクスを収集します。

jvm.gc.cms.count   => jvm.gc.minor_collection_count
                      jvm.gc.major_collection_count
jvm.gc.parnew.time => jvm.gc.minor_collection_time
                      jvm.gc.major_collection_time

参考資料

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

OpenTelemetry ランタイムメトリクスよくあるご質問 ログとトレースの相関よくあるご質問 アプリケーションを手動でインスツルメントしてトレースを作成するよくあるご質問 サービス、リソース、トレースの調査よくあるご質問