10000 Exception Replay doc title and content fixes by sstonehill12 · Pull Request #29397 · DataDog/documentation · GitHub
[go: up one dir, main page]

Skip to content

Exception Replay doc title and content fixes #29397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations 10000
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 47 additions & 26 deletions content/en/error_tracking/backend/exception_replay.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,32 @@
---
title: Error Tracking Exception Replay
title: Exception Replay in Error Tracking
is_beta: true
description: Learn about Exception Replay in Error Tracking.
further_reading:
- link: 'https://www.datadoghq.com/blog/exception-replay-datadog/'
tag: 'Blog'
text: 'Simplify production debugging with Datadog Exception Replay'
- link: '/tracing/live_debugger'
tag: 'Documentation'
text: 'Learn about Datadog Live Debugger'
- link: '/error_tracking/monitors'
tag: 'Documentation'
text: 'Learn about Error Tracking Monitors'
- link: '/tracing/error_tracking'
tag: 'Documentation'
text: 'Learn about Error Tracking for APM Backend Services'
- link: 'https://www.datadoghq.com/blog/exception-replay-datadog/'
tag: 'Blog'
text: 'Simplify production debugging with Datadog Exception Replay'
aliases:
- /tracing/error_tracking/executional_context
- /tracing/error_tracking/execution_replay/
---

<div class="alert alert-info">
Exception Replay for APM Error Tracking is in Preview
Exception Replay for APM Error Tracking is generally available for Python, and in Preview for Java, .NET, and PHP.
</div>

## Overview

Exception Replay in APM Error Tracking automatically captures production variable values so you can reproduce exceptions from Error Tracking issues.
Exception Replay in APM Error Tracking automatically captures production variable values to help you reproduce exceptions from Error Tracking issues.

{{< img src="tracing/error_tracking/error_tracking_executional_context-2.png" alt="Error Tracking Explorer Exception Replay" style="width:90%" >}}

Expand All @@ -38,49 +41,67 @@ Supported languages
- `dd-trace-dotnet` for .NET
- `dd-trace-php` for PHP

Exception Replay is only available in APM Error Tracking. Error Tracking for Logs and RUM is not supported.
Exception Replay is only available in APM Error Tracking. It is not available for errors sourced from Logs and RUM.

## Setup

1. Install or upgrade your Agent to version `7.44.0` or higher.
2. Ensure that you are using:
* `ddtrace` version `1.16.0` or higher.
* `dd-trace-java` version `1.47.0` or higher.
* `dd-trace-dotnet` version `2.53.0` or higher.
4. Set the `DD_EXCEPTION_REPLAY_ENABLED` environment variable to `true` to run your service with Error Tracking Exception Replay enabled.
1. Upgrade the Datadog Agent to version `7.44.0` or higher.
1. Upgrade the APM tracer library to the minimum required version or higher:
* `ddtrace` version `1.16.0+`
* `dd-trace-java` version `1.47.0+`
* `dd-trace-dotnet` version `2.53.0+`
* `dd-trace-php` version `1.5.0+`
1. Run your service with the `DD_EXCEPTION_REPLAY_ENABLED` environment variable set to `true`.
1. [Create a logs index][9] and configure it to the desired retention with no sampling.
* Set the filter to match on the `source:dd_debugger` tag.
* Ensure that the new index takes precedence over any others with filters that match that tag, because the first match wins.

<div class="alert alert-info">
<b>Why create a logs index?</b> When an error occurs and is captured in an APM span, Exception Replay variable snapshots are captured as logs with reference links to the APM span. When viewing the error in Error Tracking Explorer, variable snapshots from the log data display alongside stack trace details.
</div>

### Redacting sensitive data

After you enable Sensitive Data Scrubbing, by default, variable data linked to specific identifiers deemed sensitive, such as `password` and `accessToken`, is automatically redacted. Enable Sensitive Data Scrubbing rules [in Datadog][7]. See the full [list of redacted identifiers][1].
By default, Exception Replay automatically redacts variable data linked to sensitive identifiers like `password` and `accessToken`. See the full [list of redacted identifiers][1].

You can also scrub variable data for PII by:
- [Creating custom identifier redaction][2].
- [Redacting based on specific classes or types][3].
- Creating a [Sensitive Data Scanner][4] rule and applying it to logs that match the query `dd_source:debugger`.
Scrub Exception Replay variable snapshots for PII and other sensitive data by:
- [Creating custom identifier redaction][2]
- [Redacting based on specific classes or types][3]
- Creating a [Sensitive Data Scanner][4] rule and applying it to logs that match `source:dd_debugger`

To learn more about scrubbing variable data, see [Dynamic Instrumentation Sensitive Data Scrubbing][5].
For more information, see [Dynamic Instrumentation Sensitive Data Scrubbing][5].

<div class="alert alert-info">
<b>Note:</b> Dynamic Instrumentation is NOT a prerequisite for Sensitive Data Scrubbing. Sensitive Data Scrubbing applies to Exception Replay variable snapshots by default regardless of whether Dynamic Instrumentation is enabled on the service.
</div>

## Getting started

1. Navigate to [**APM** > **Error Tracking**][6].
2. Click into any Python Error Tracking issue and scroll down to the stack trace component.
3. Expand stack frames to examine captured variable values.
2. Click an Error Tracking issue on a service with Exception Replay enabled.
3. Scroll down to the stack trace component.
4. Expand stack frames to examine captured variable values.

## Troubleshooting

### A specific Python error trace does not have variable values
To keep the performance overhead of the feature at a minimum, error capturing is rate limited: one error per second includes variable data. If you don't see variable values on a given trace:
### A specific error trace does not have variable values
Exception Replay variable snapshots are rate limited to ensure negligible impact on application performance. For a given exception or issue, a variable snapshot is captured at most once per hour (per instance or pod). If variable values are not visible on a trace, try these options:

1. Click **View Similar Errors**.
2. Expand the time range selection to find another instance of the exception where variable values were captured.
- Confirm Exception Replay is enabled on the source service and environment.
- Click **View Similar Errors**.
- Expand the time range selection to find error instances with captured variable values.
- Use the search query `@error.debug_info_captured:true` in [Error Tracking Explorer][6].
- Check [Log Indexes][9] to confirm logs with the tag `source:dd_debugger` have appropriate retention and aren't affected by [Exclusion Filters][8] in preceding indexes.

[1]: https://github.com/DataDog/dd-trace-py/blob/2bd8e73b639af811cee2703198aa9e7e32b2f74e/ddtrace/debugging/_redaction.py
[1]: https://github.com/DataDog/dd-trace-py/blob/main/ddtrace/debugging/_redaction.py
[2]: /dynamic_instrumentation/sensitive-data-scrubbing/#custom-identifier-redaction
[3]: /dynamic_instrumentation/sensitive-data-scrubbing/#redact-based-on-specific-classes-or-types
[4]: /security/sensitive_data_scanner/
[5]: /dynamic_instrumentation/sensitive-data-scrubbing/
[6]: https://app.datadoghq.com/apm/error-tracking
[7]: https://app.datadoghq.com/dynamic-instrumentation/setup
[8]: /logs/log_configuration/indexes/#exclusion-filters
[9]: https://app.datadoghq.com/logs/pipelines/indexes

## Further Reading

Expand Down
6 changes: 3 additions & 3 deletions content/en/tracing/error_tracking/exception_replay.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Error Tracking Explorer
description: Learn about the Error Tracking Explorer.
title: Exception Replay in Error Tracking
description: Learn about Exception Replay in APM Error Tracking.
further_reading:
- link: '/monitors/types/error_tracking'
tag: 'Documentation'
text: 'Learn about Error Tracking Monitors'
---

{{< include-markdown "error_tracking/backend/exception_replay" >}}
{{< include-markdown "error_tracking/backend/exception_replay" >}}
Loading
0