Skip to content

docs(rum): add Browser SDK v6 to v7 upgrade guide#36214

Open
thomas-lebeau wants to merge 7 commits intomasterfrom
thomas.lebeau/browser-sdk-v7-upgrade-guide
Open

docs(rum): add Browser SDK v6 to v7 upgrade guide#36214
thomas-lebeau wants to merge 7 commits intomasterfrom
thomas.lebeau/browser-sdk-v7-upgrade-guide

Conversation

@thomas-lebeau
Copy link
Copy Markdown
Contributor

@thomas-lebeau thomas-lebeau commented Apr 23, 2026

What does this PR do? What is the motivation?

Adds a new upgrade guide covering the Browser SDK v6 to v7 migration.

  • Documents breaking changes across Core, RUM, Logs, and Session Replay packages
  • Covers the session manager rewrite, new privacy defaults, removed options, and updated API surface

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

AI assistance

Used Claude Code to draft the upgrade guide content.

Additional notes

- Document breaking changes for Core, RUM, Logs, and Session Replay
- Cover session manager rewrite, new privacy defaults, removed options,
  and API changes for v7 migration
@github-actions github-actions Bot added the Guide Content impacting a guide label Apr 23, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Preview links (active after the build_preview check completes)

Modified Files

- Add new section explaining how to update CDN bundle URL from v6 to v7
- Clarify that the crossorigin attribute goes on the script tag
- Update reference [28] to point to the datadoghq.dev RumInitConfiguration interface page for more detailed parameter documentation
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
- Replace temporal words (now, previously) with explicit v7 references per Vale style rules
- Clarify action name computation strategy description
- Rename Session Replay section to reflect data format change rather than serialization algorithm
@thomas-lebeau thomas-lebeau marked this pull request as ready for review April 23, 2026 13:37
@thomas-lebeau thomas-lebeau requested review from a team as code owners April 23, 2026 13:37
@iadjivon iadjivon added the editorial review Waiting on a more in-depth review label Apr 23, 2026
@iadjivon
Copy link
Copy Markdown
Contributor

Added an editorial card: DOCS-14156

thomas-lebeau added a commit to DataDog/browser-sdk that referenced this pull request Apr 24, 2026
Content has been moved to the documentation repo:
DataDog/documentation#36214
- Mention the upgrade-browser-sdk-v7 skill to help automate migration steps
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
- Replace "better" with "sensible" for defaultPrivacyLevel description
- Clarify enablePrivacyForActionName guidance to note upcoming build plugin masking capabilities
Copy link
Copy Markdown
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @thomas-lebeau thanks for this PR! i left some suggestions mainly for clarity and consistency with our style guide.

one thing i'd like to ask is that we leave the [28] link to point at the internal reference, but can you create a follow up PR to update it with the v7 parameters?

Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
Comment thread content/en/real_user_monitoring/guide/browser-sdk-upgrade.md Outdated
[25]: /real_user_monitoring/correlate_with_other_telemetry/apm#opentelemetry-support
[27]: /real_user_monitoring/guide/proxy-rum-data
[28]: /real_user_monitoring/application_monitoring/browser/setup/#initialization-parameters
[28]: https://datadoghq.dev/browser-sdk/interfaces/_datadog_browser-rum.RumInitConfiguration.html
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will take users to the external reference. can we keep /real_user_monitoring/application_monitoring/browser/setup/#initialization-parameters but open a different PR to update it with v7 parameters?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page does not contain an #initialization-parameters section. I did not follow the closely everything but the list of all initialization options have been removed from the documentation website a while back in favor of an automatically generated API documentation.

This is the same link used in the 3rd step in Manual client-side setup
Screenshot 2026-04-30 at 08 12 48

Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorial review Waiting on a more in-depth review Guide Content impacting a guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants