diff --git a/packages/debugger/README.md b/packages/debugger/README.md index e091466c63..f148daba94 100644 --- a/packages/debugger/README.md +++ b/packages/debugger/README.md @@ -17,10 +17,12 @@ datadogDebugger.init({ site: '', service: 'my-web-application', // env: 'production', - // version: '1.0.0', + // version: 'my-deployed-build-version', }) ``` +If provided, `version` should be set to the immutable deployed browser build identifier used for source map upload and browser build resolution. If omitted, debugger delivery and snapshots still work, but browser build lookup and source-aware resolution may be unavailable. + If [Datadog RUM][3] is also initialized on the page, debugger snapshots automatically include RUM context (session, view, user action) without any additional configuration. ## Troubleshooting diff --git a/packages/debugger/src/entries/main.ts b/packages/debugger/src/entries/main.ts index 064fd39c6a..e420762330 100644 --- a/packages/debugger/src/entries/main.ts +++ b/packages/debugger/src/entries/main.ts @@ -88,6 +88,7 @@ export interface DebuggerPublicApi extends PublicApi { * service: 'my-app', * site: 'datadoghq.com', * env: 'production' + * version: 'my-deployed-build-version', * }) * ``` */