Skip to content

Document optional browser debugger version #4503

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.

Sign up for GitHub

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

Closed
watson wants to merge 1 commit into from
Closed

Document optional browser debugger version #4503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/debugger/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ datadogDebugger.init({
site: '<DATADOG_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
Expand Down
1 change: 1 addition & 0 deletions packages/debugger/src/entries/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ export interface DebuggerPublicApi extends PublicApi {
* service: 'my-app',
* site: 'datadoghq.com',
* env: 'production'
* version: 'my-deployed-build-version',
* })
* ```
*/
Expand Down
Loading