You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(debugger): update setup requirements and reorganize documentation
- Update tracer version requirements:
- In-App: Python ≥3.1.0, Java ≥1.48.0, .NET ≥3.29.0
- Env Var: Add Node.js ≥5.39.0, Ruby ≥2.9.0, PHP ≥1.5.0; update Python to ≥2.2.0, Java to ≥1.34.0, .NET to ≥2.54.0
- Add "Create a logs index" section with exclusion filter configuration steps
- Add "Link your source code" section for Source Code Integration
- Minor copy improvements for clarity
- Reorder and remove unused references
These changes align Live Debugger current product capabilities
and provide clear setup guidance for all supported languages with less reliance
on the Dynamic Instrumentation documentation.
Enable and disable Live Debugger on a service using one of the following methods:
63
+
To enable Live Debugger in-app, navigate to the Live Debugger **Settings** page, select the desired service, and toggle
64
+
it to **Enabled**.
60
65
61
-
#### One-click enablement (recommended) ####
66
+
If in-app enablement isn't available, follow the instructions below for your target language:
62
67
63
-
<divclass="alert alert-info">Only users with the following permissions can use one-click enablement: <b>Org Management, APM Remote Configuration Read, APM Remote Configuration Write</b>.</div>
1. Select the service and environment on the [Live Debugger Settings][18] page.
66
-
1. Check that all prerequisites are met as indicated on the Settings page.
67
-
1. Click "Enable" or "Disable":
68
-
- "Enable" to allow users to create Debug Sessions on the selected service and environment.
69
-
- "Disable" to deactivate active Debug Sessions and prevent users from creating more.
70
+
<divclass="alert alert-info">
71
+
<b>Why DI instructions?</b>
72
+
Live Debugger is built on <ahref="/tracing/dynamic_instrumentation/">Dynamic Instrumentation (DI)</a>, so its
73
+
setup instructions and limitations also apply here.
74
+
</div>
70
75
71
-
**Note**: No service restart is required for changes to take effect. Admins and security contacts receive email notifications when services are enabled or disabled.
76
+
### Create a logs index
72
77
73
-
#### Manual enablement ####
74
-
1. Select the service and environment on the [Live Debugger Settings][18] page.
75
-
1. Follow the instructions to enable Live Debugger.
76
-
1. Restart the service before using Live Debugger.
78
+
Live Debugger generates logs that are sent to Datadog and appear alongside your application logs.
77
79
80
+
If you use [Exclusion filters][11], ensure Live Debugger logs are not filtered:
78
81
79
-
## Live Debugger and Dynamic Instrumentation
80
-
Due to shared underlying technology, Live Debugger and Dynamic Instrumentation are always enabled or disabled together on the same service and environment.
82
+
1. Create a logs index and [configure it][12] to the desired retention with **no sampling**.
83
+
2. Set the filter to match on the `source:dd_debugger` tag. All Dynamic Instrumentation logs have this source.
84
+
3. Ensure that the new index takes precedence over any other with filters that match that tag, because the first match wins.
81
85
82
-
Like Live Debugger, Dynamic Instrumentation allows users to create logpoints (in addition to supporting other custom instrumentation like spans, span tags, and metrics). However, Live Debugger logpoints expire automatically after a set time period, while Dynamic Instrumentation logpoints remain active until manually deactivated.
86
+
### Link your source code
83
87
84
-
When you enable or disable Live Debugger, the same action applies to Dynamic Instrumentation for that service and environment. When disabled, all data capture stops from both active Debug Session logpoints and dynamic instrumentations.
88
+
If you enable the Datadog Source Code Integration, you can debug code directly through
89
+
Live Debugger.
85
90
86
91
## Using Live Debugger
87
92
@@ -92,8 +97,8 @@ When you enable or disable Live Debugger, the same action applies to Dynamic Ins
92
97
A Debug Session lets you inspect running code using auto-expiring logpoints. To create and use a Debug Session:
93
98
94
99
1. Start a Debug Session from one of the following locations:
95
-
- On the [Live Debugger page][14], click **Create Debug Session**.
96
-
- (Requires the Code Origin feature) In the [Trace Explorer][22], open a trace, locate the Code Origin section in the side panel, and click **Start Debug Session**.
100
+
- On the [Live Debugger page][13], click **Create Debug Session**.
101
+
- (Requires the Code Origin feature) In the [Trace Explorer][14], open a trace, locate the Code Origin section in the side panel, and click **Start Debug Session**.
97
102
2. Add a logpoint to begin collecting diagnostic data.
98
103
3. Add, remove, or modify logpoints as needed during the session.
99
104
@@ -103,35 +108,34 @@ Debug Sessions expire automatically. You can also manually disable or re-enable
103
108
104
109
Logpoints are "non-breaking breakpoints" that specify where in the code to capture information, what data to include, and under what conditions. To add a logpoint for debugging:
105
110
106
-
1. Go to the [Live Debugger page][14].
111
+
1. Go to the [Live Debugger page][13].
107
112
2. Click **Create Debug Session**.
108
113
3. Choose your service, environment, and select where in your code to place the first logpoint.
109
-
4. Define a logpoint message template using the [Dynamic Instrumentation expression language][2].
114
+
4. Define a logpoint message template using the [expression language][15].
110
115
5. (Optional) Enable "Capture Variables" to collect all execution context (this feature is rate-limited to 1 execution per second).
111
116
6. (Optional) Define a condition for when the logs should be emitted.
112
117
113
-
**Note:** Some feature limitations may apply depending on the service's runtime language. Review the [runtime language-specific documentation][17] for more details.
118
+
**Note:** Some feature limitations may apply depending on the service's runtime language. Review the [runtime language-specific documentation][16] for more details.
114
119
115
120
### Protecting sensitive data
116
121
117
122
Live Debugger data might contain sensitive information, especially when using the "Capture Variables" option. To protect this data:
118
123
119
-
1. Use the built-in [sensitive data scrubbing][3] mechanisms.
120
-
2. Use [Sensitive Data Scanner][15] to identify and redact sensitive information based on regular expressions.
124
+
1. Use the built-in [sensitive data scrubbing][1] mechanisms.
125
+
2. Use [Sensitive Data Scanner][17] to identify and redact sensitive information based on regular expressions.
121
126
122
127
## Impact on performance and billing
123
128
124
-
Enabling Live Debugger and Dynamic Instrumentation on a service does not trigger data capture or impact performance. Data capture only occurs when there are active Debug Sessions or dynamic instrumentations on that service.
129
+
Enabling Live Debugger on a service does not trigger data capture or impact performance. Data capture only occurs when there are active Debug Sessions on that service.
125
130
126
131
**Performance impact**: Datadog's agent-driven instrumentation ensures minimal impact on application performance; sampling logic, rate limits, and built-in budgets prevent runaway data capture.
127
132
128
-
**Pricing impact**: Logs captured by Datadog are all billed the same way, whether they are generated from Live Debugger or logger lines in your source code. With Live Debugger, the logpoints automatically expire after the set time period, limiting unnecessary data accumulation and costs. Monitor your [Datadog Plan & Usage page][21] for any unexpected increases after utilizing a new feature.
133
+
**Pricing impact**: Logs captured by Datadog are all billed the same way, whether they are generated from Live Debugger or logger lines in your source code. With Live Debugger, the logpoints automatically expire after the set time period, limiting unnecessary data accumulation and costs. Monitor your [Datadog Plan & Usage page][18] for any unexpected increases after utilizing a new feature.
129
134
130
135
## Limitations
131
136
132
137
The following constraints apply to Live Debugger usage and configuration:
133
138
134
-
-**Language support:** Live Debugger is available for the same runtime languages as [Dynamic Instrumentation][1], including: Java, Python, .NET, PHP (preview), Node.js (preview), Ruby (preview).
135
139
-**Configuration scope:** Live Debugger and Dynamic Instrumentation are enabled or disabled together for the same service and environment.
136
140
-**Rate limits:**
137
141
- Logpoints with variable capture: Limited to 1 execution per second.
@@ -141,25 +145,22 @@ The following constraints apply to Live Debugger usage and configuration:
0 commit comments