Error Tracking における Exception Replay

This product is not supported for your selected Datadog site. ().
Exception Replay は、Python、Java、.NET、PHP で一般提供されており、サポートされている場合はデフォルトで有効になっています。 (サポートされている場合)。

概要

Exception Replay は、例外が発生したときに実行コンテキストとローカル変数の値をキャプチャし、問題の診断、 問題の再現と解決を迅速化します。スタックトレースや変数のスナップショットを含む周囲の状態を記録し、 そのデータを Error Tracking 内の他の問題詳細と並べて直接表示します。

Error Tracking Explorer Exception Replay

Exception Replay は本番環境での使用を想定して設計されています。スナップショットはレート制限されており、機密データは自動的に マスクされます。有効にすると、アプリケーション内の例外を待機し、スナップショットをキャプチャします。 スタックトレースとローカル変数を Datadog に転送する前にキャプチャします。

サポートされている製品は何ですか Exception Replay は APM ベースの例外でのみ利用可能で、Logs や RUM からのエラーはサポートしていません。

要件とセットアップ

Exception Replay は Python、Java、.NET、PHP をサポートし、APM ベースの例外のみをキャプチャします。これには Datadog Agent と APM-instrumented application が必要です。環境全体、 アプリ内の個別のサービス、または環境変数を使用した特定のサービスに対して有効にできます。

有効化の方法は、トレーサーのバージョンと Remote Configuration が利用可能かどうかによって異なります。詳細については、 以下の表を参照してください。

環境別
(一括)		サービス別
(アプリ内)		サービス別
(環境変数)
有効化方法デフォルトで有効設定ページ環境変数
Agent バージョンv7.49.0+v7.49.0+v7.49.0+
最小トレーサーバージョンPython ≥ 3.15.0
Java ≥ 1.54.0
.NET ≥ 3.29.0
PHP ≥ 1.19.0		Python ≥ 3.10.0
Java ≥ 1.48.0
.NET ≥ 3.29.0
PHP ≥ 1.14.0		Python ≥ 1.16.0
Java ≥ 1.47.0
.NET ≥ 2.53.0
PHP ≥ 1.12.1
Remote Configuration が必要かはいはいいいえ

Exception Replay をアプリ内で有効にするには、Error Tracking の Exception Replay Settings ページに移動し、 目的の環境またはサービスを選択して、Enabled に切り替えます。

アプリ内での有効化が利用できない場合は、環境変数を設定します。

DD_EXCEPTION_REPLAY_ENABLED=true

これはアプリ内の構成を上書きするためにも使用でき、両方が設定されている場合はこちらが優先されます。

Exception Replay スナップショット用のログインデックスを作成

Exception Replay スナップショット専用のログインデックスを作成し、目的の保持期間を設定して、サンプリングを無効にします。

  • フィルターを source:dd_debugger に設定します。
  • このインデックスが、このタグに一致する他のインデックスよりも優先されるようにします (最初に一致したものが優先されます)。
ログインデックスを作成する理由 Exception Replay スナップショットは、元の APM スパンへのリンクが付加されたログとして出力されます。

Datadog Source Code Integration を有効にすると、Error Tracking の スタックトレース内で直接コードプレビューを確認できます。Exception Replay スナップショットがキャプチャされると、コードプレビュー内の変数名にカーソルを合わせて、 キャプチャされた値を確認できます。

機密データのリダクション

Exception Replay は、自動的なモードベースおよび識別子ベースのリダクションを適用し、スナップショットが利用可能になる前に機密データが保護されるようにします。 スナップショットが利用可能になります。

モードベースのリダクション

Exception Replay には 2 つのリダクションモードがあります。

  • Strict Mode: 数値とブール値を除くすべての値をリダクションします。
  • Targeted Mode: クレジットカード番号、API キー、IP アドレス、その他の個人情報 (PII) など、既知の機密パターンをリダクションします。また、高エントロピーのシークレットスキャナーを実行し、シークレットの可能性が高いものを自動的にリダクションします。これらはスナップショット内で [REDACTED:HIGH_ENTROPY] として表示されます。

これらのリダクションモードは無効にすることはできず、切り替えることのみ可能です。 また、Targeted Mode は、staging や preprod のような一般的な本番前環境で自動的に適用されます。

識別子ベースのリダクション

一般的なセンシティブ識別子 に関連付けられた変数値 (例: password、accessToken、および類似の用語) は、 スナップショットがホストから離れる前にスクラブされます。言語固有の追加のリダクションルールが各トレーサーに組み込まれています。 (例: Python トレーサーはデフォルトのセンシティブ識別子のリストを保持しています)。

リダクション動作は以下を通じて拡張できます。

  • カスタム識別子ベースのリダクション
  • クラス/タイプベースのリダクションルール
  • Sensitive Data Scanner ルール

Dynamic Instrumentation センシティブデータスクラビングの手順 および Sensitive Data Scanner のドキュメントを参照してください。 構成の詳細については、以下を確認してください。

DI の指示が必要な理由 Exception Replay は Dynamic Instrumentation (DI) に基づいて構築されているため、 そのセンシティブデータスクラビングの構成オプションもここで適用されます。

トラブルシューティング

変数値が欠落している

Exception Replay のスナップショットには、インスタンスごと、例外タイプごとに 1 時間あたり 1 回というレート制限が適用されます。一部の ランタイムでは、特定の例外について、2 回目の発生後にのみスナップショットがキャプチャされます。

スナップショットが表示されないその他の理由

  • Exception Replay が有効になっていない
  • スナップショットが選択した時間枠外で発生した
  • サードパーティパッケージの除外 (これらを含めるには DD_THIRD_PARTY_DETECTION_EXCLUDES を使用)
  • Log Index の保持設定または先行するインデックスの Exclusion Filters により source:dd_debugger が欠落しているログ
  • Exception Replay は FedRAMP リージョンでは利用できません
  • Java: JDK 18 以下では、-parameters フラグでコンパイルされたクラスはサポートされない場合があります。Spring 6+、Spring Boot 3+、および Scala は、このフラグをデフォルトで使用します。
  • .NET：FIPSが有効なホストでは、3.55.0より前のトレーサーはException Replayをサポートしていません。Linuxでは、アプリケーションがクラッシュします。Exception Replayを使用するには、トレーサーを3.55.0以降にアップグレードしてください。以前のバージョンでは、クラッシュを回避するためにDD_EXCEPTION_REPLAY_ENABLED=falseを設定してください。

Error Tracking Explorer でクエリ @error.debug_info_captured:true を使用して、Exception Replay のスナップショットを含むエラーを検索します 。

GovCloud 上の BatchUploader の WARN メッセージ (Java)

GovCloud サイト (app.ddog-gov.com) では、Java トレーサーが com.datadog.debugger.uploader.BatchUploader から HTTP 403 および This traffic is not permitted on your account に類似したテキストを含む WARN メッセージを定期的にログに出力する場合があります。これは、Exception Replay、Dynamic Instrumentation、および Code Origin for Spans がサポートされていないサイトで、デバッガー関連のアップロードが試行された場合の想定された動作です。APM のコア機能 (トレース、メトリクス、プロファイリング、ログインジェクション) には影響ありません。

これらのログメッセージを停止するには、Java アプリケーション Pod で以下の環境変数を設定し、ワークロードを再起動します。

DD_EXCEPTION_REPLAY_ENABLED=false
DD_DYNAMIC_INSTRUMENTATION_ENABLED=false
DD_CODE_ORIGIN_FOR_SPANS_ENABLED=false

または、JVM システムプロパティを使用します。

-Ddd.exception.replay.enabled=false
-Ddd.dynamic.instrumentation.enabled=false
-Ddd.code.origin.for.spans.enabled=false

修正を確認するには、トレーサーの起動 JSON (DATADOG TRACER CONFIGURATION) を確認し、debugger_exception_enabled、debugger_enabled、および debugger_span_origin_enabled がすべて false であることを確認します。WARN メッセージはレート制限により約 5 分に 1 回のみ出力されるため、再起動後、メッセージが停止したことを確認するまで少なくともその程度の時間待ちます。

参考資料

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

Datadog Exception Replay で本番デバッグを簡素化ブログ more more Datadog Live Debugger について学習します。ドキュメント more more Error Tracking Monitors について学習します。ドキュメント more more APM バックエンドサービスの Error Tracking について学習します。ドキュメント more more