概要

Exception Replay は、例外発生時の実行コンテキストとローカル変数の値をキャプチャして、問題を迅速に診断、 再現、解決できるようにします。スタックトレースや変数スナップショットなどの例外発生時の状況を記録し、 このデータを問題のその他の詳細とともに Error Tracking に直接表示します。

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

要件とセットアップ

Exception Replay は Python、Java、.NET、PHP をサポートしており、APM ベースの例外のみをキャプチャします。Exception Replay には、 Datadog Agent と APMインスツルメンテーション済みアプリケーションが必要です。環境全体、 アプリ内の個別のサービス、または環境変数を使用した特定のサービスに対して有効にできます。

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

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

アプリ内での有効化が利用できない場合は、次のように環境変数を設定してください。

DD_EXCEPTION_REPLAY_ENABLED=true

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

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

Exception Replay スナップショット専用のログインデックスを作成し、目的の保持期間とサンプリングなしで構成します。

• source:dd_debugger に一致するようにフィルターを設定します。
• このインデックスが、このタグに一致するほかのインデックスよりも優先されるようにします (最初に一致したものが優先されます)。

ソースコードをリンクする

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

機密データの削除

Exception Replay は、スナップショットが利用可能になる前に、機密データが確実に保護されるように、 モードまたは識別子に基づく自動削除を実施します。

モードに基づく削除

Exception Replay には、次の 2 つの編集モードがあります。

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

これらの削除モードは無効にすることはできず、切り替えのみが可能です。対象のモードは、 staging や preprod のような一般的なプリプロダクション環境で自動的に適用されます。

識別子に基づく編集

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

削除動作は、以下を使用して拡張できます。

• カスタム識別子に基づく削除
• クラス/型に基づく削除ルール
• Sensitive Data Scanner のルール

設定の詳細については、Dynamic Instrumentation の機密データスクラブ手順および Sensitive Data Scanner のドキュメントを 参照してください。

トラブルシューティング

変数値が見つからない

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

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

• Exception Replay が有効になっていない
• スナップショットが選択した時間枠外で発生した
• サードパーティパッケージが除外されている (これらを含めるには DD_THIRD_PARTY_DETECTION_EXCLUDES を使用してください)
• ログインデックスの保持設定または先行するインデックスの除外フィルターが原因で、source:dd_debugger がログに含まれていない
• Exception Replay は FedRAMP リージョンでは使用できない
• Java: JDK 18 以下では、-parameters フラグを指定してコンパイルされたクラスはサポートされない場合があります。Spring 6 以上、Spring Boot 3 以上、および Scala では、このフラグがデフォルトで使用されます。

Error Tracking エクスプローラーでクエリ @error.debug_info_captured:true を使用して、Exception Replay スナップショットのあるエラーを 検出してください。

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

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 で本番環境のデバッグを簡素化ブログ Datadog Live Debugger について学ぶドキュメント Error Tracking モニターについて学ぶドキュメント APM バックエンドサービスの Error Tracking について学ぶドキュメント