Skip to content

Add browser SDK setup options to Cdocs browser partial#37270

Open
rtrieu wants to merge 14 commits into
masterfrom
rtrieu/add-browser-setup-options
Open

Add browser SDK setup options to Cdocs browser partial#37270
rtrieu wants to merge 14 commits into
masterfrom
rtrieu/add-browser-setup-options

Conversation

@rtrieu
Copy link
Copy Markdown
Contributor

@rtrieu rtrieu commented Jun 4, 2026

What does this PR do? What is the motivation?

Fixes DOCS-14485

  • Restructures the Browser SDK setup page into three collapsible options with guided steps (manual client-side, Agentic Onboarding, and server-side auto-instrumentation), so users only see instructions relevant to their workflow
  • Adds a comparison table for the three setup methods, so users can quickly choose the right one
  • Adds a note that server-side auto-instrumentation only supports RUM, so users aren't surprised by missing Session Replay or Product Analytics support
  • Fixes stepper heading levels in the Browser, Unity, Flutter, and Kotlin Multiplatform setup guides so step titles don't clutter the page Table of Contents

Best to preview this page: https://docs-staging.datadoghq.com/rtrieu/add-browser-setup-options/client_sdks/setup/?platform=browser

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

@rtrieu rtrieu requested review from a team as code owners June 4, 2026 18:47
@github-actions github-actions Bot added Architecture Everything related to the Doc backend cdocs labels Jun 4, 2026
@rtrieu rtrieu added the WORK IN PROGRESS No review needed, it's a wip ;) label Jun 4, 2026
@rtrieu
Copy link
Copy Markdown
Contributor Author

rtrieu commented Jun 4, 2026

Closing — change was accidentally committed to the wrong branch. New PR incoming.

@rtrieu rtrieu closed this Jun 4, 2026
@rtrieu rtrieu reopened this Jun 4, 2026
@rtrieu rtrieu changed the title [DOCS-14485] Add GovCloud unavailability banner to Heatmaps page Add browser SDK setup options to Cdocs browser partial Jun 4, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 4, 2026

@rtrieu rtrieu removed the WORK IN PROGRESS No review needed, it's a wip ;) label Jun 5, 2026
@rtrieu
Copy link
Copy Markdown
Contributor Author

rtrieu commented Jun 5, 2026

⚠️ Possible site support note detected

The following files have a site-region shortcode at the top of the page that mentions a feature being "not available" or "not supported":

  • content/en/real_user_monitoring/application_monitoring/browser/setup/_index.md

Are you trying to document site support for a product? If so, the site-region shortcode is not the recommended approach. See the Documenting site support guide for the preferred method.

@github-actions this can be ignored because it's for the specific instrumentation option

@rtrieu rtrieu added the WORK IN PROGRESS No review needed, it's a wip ;) label Jun 5, 2026
@rtrieu rtrieu removed the WORK IN PROGRESS No review needed, it's a wip ;) label Jun 5, 2026
@urseberry urseberry self-assigned this Jun 5, 2026
Copy link
Copy Markdown
Contributor

@urseberry urseberry left a comment

Choose a reason for hiding this comment

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

Thanks for the detailed summary in the PR description to help me understand the scope of the changes!

I did not contact cdocs-reviewers, so make sure that you also get a review from someone in that group.

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 file needs to be removed from the repository and from this PR, since it will be generated by Cdocs going forward. Similarly, you need to add an entry for it to the .gitignore. For an example, see #36102

Comment on lines 376 to 377
[12]: /real_user_monitoring/application_monitoring/browser/setup/server
[13]: /real_user_monitoring/application_monitoring/agentic_onboarding/?tab=realusermonitoring
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.

Suggested change
[13]: /real_user_monitoring/application_monitoring/agentic_onboarding/?tab=realusermonitoring

The body no longer references links 12 and 13, so you should remove them.

@@ -0,0 +1,11 @@
#### Limitations

Auto-instrumentation for this server has the following limitations. If your use case requires more control, use [client-side instrumentation][101] instead.
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.

Suggested change
Auto-instrumentation for this server has the following limitations. If your use case requires more control, use [client-side instrumentation][101] instead.
Server-side auto-instrumentation has the following limitations. If your use case requires more control, use [client-side instrumentation][101] instead.

When this partial shows up on the index page (https://docs-staging.datadoghq.com/rtrieu/add-browser-setup-options/client_sdks/setup/), the user hasn't had to select a server, so "this server" doesn't make sense. I suggest rewording it to be more general.


## Overview

The Datadog Browser SDK enables Real User Monitoring (RUM) for your web applications, providing comprehensive visibility into user experience and application performance. With RUM, you can monitor page load times, user interactions, resource loading, and application errors in real-time.
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.

Suggested change
The Datadog Browser SDK enables Real User Monitoring (RUM) for your web applications, providing comprehensive visibility into user experience and application performance. With RUM, you can monitor page load times, user interactions, resource loading, and application errors in real-time.
The Datadog Browser SDK enables Real User Monitoring (RUM) for your web applications, providing visibility into user experience and application performance. With RUM, you can monitor page load times, user interactions, resource loading, and application errors in real time.

There are three ways to instrument your browser-based web applications with the Browser SDK:

- [**Manual client-side setup**][1]: Instrument your browser-based web applications, deploy them, configure the initialization parameters you want to track, and use advanced configuration to further manage the data and context that RUM collects.
- [**Agentic Onboarding**][2]: Instrument your frontend applications with one prompt using LLM coding agents like Cursor or Claude.
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.

Suggested change
- [**Agentic Onboarding**][2]: Instrument your frontend applications with one prompt using LLM coding agents like Cursor or Claude.
- [**Agentic Onboarding**][2]: Instrument your frontend applications with one prompt using LLM coding agents such as Cursor or Claude.

| **SDK setup mechanism** | Manually add the RUM SDK to your application code and manage configurations in code. | Use an AI-guided setup that detects your project's framework and adds the RUM SDK with a single prompt. | Automatically add RUM JS to your web app HTML, then manage configurations in the UI. |
| **Code changes required** | Yes | Yes (automated by AI agent) | No |
| **Setup complexity** | Medium | Low | Low |
| **Supported platforms** | All browser-based applications | Next.js, React, Svelte, Vue, Vanilla JavaScript | Apache, IBM HTTP Server, Java Servlet, Nginx, Windows IIS |
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.

Suggested change
| **Supported platforms** | All browser-based applications | Next.js, React, Svelte, Vue, Vanilla JavaScript | Apache, IBM HTTP Server, Java Servlet, Nginx, Windows IIS |
| **Supported platforms** | All browser-based applications | Next.js, React, Svelte, Vue, Vanilla JavaScript | Apache, IBM HTTP Server, Java Servlet, NGINX, Windows IIS |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend cdocs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants