Skip to content

Add RUM Debug Widget to troubleshooting.md#35347

Open
kikoveiga wants to merge 2 commits intomasterfrom
kikoveiga/add-rum-debug-widget-to-android-sdk-troubleshooting-page
Open

Add RUM Debug Widget to troubleshooting.md#35347
kikoveiga wants to merge 2 commits intomasterfrom
kikoveiga/add-rum-debug-widget-to-android-sdk-troubleshooting-page

Conversation

@kikoveiga
Copy link

@kikoveiga kikoveiga commented Mar 17, 2026

What does this PR do? What is the motivation?

  • Adds a reference to the Rum Debug Widget in the Android SDK troubleshooting guide.

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

Claude Code to polish the sentences.

@kikoveiga kikoveiga requested a review from a team as a code owner March 17, 2026 17:23
@github-actions github-actions bot added the Images Images are added/removed with this PR label Mar 17, 2026
Datadog.setVerbosity(Log.INFO)
```

## RUM Debug Widget
Copy link
Contributor

@iadjivon iadjivon Mar 17, 2026

Choose a reason for hiding this comment

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

Suggested change
## RUM Debug Widget
## RUM debug widget

Feel free to dismiss this suggestion if this is the official/proper name of this module. Examples of products that would be capitalized in a title would be Datadog Agent or Feature Flag since these are the proper names of the products.

Copy link
Author

Choose a reason for hiding this comment

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

Yes I think we can keep the capitalization because it's a feature/product.


## RUM Debug Widget

The [RUM Debug Widget][5] provides a floating overlay that displays key metrics such as memory usage, CPU load, and RUM events in real time. It is intended for debugging and development purposes only.
Copy link
Contributor

@iadjivon iadjivon Mar 17, 2026

Choose a reason for hiding this comment

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

Suggested change
The [RUM Debug Widget][5] provides a floating overlay that displays key metrics such as memory usage, CPU load, and RUM events in real time. It is intended for debugging and development purposes only.
The [RUM Debug Widget][5] module provides a floating overlay that displays key metrics such as memory usage, CPU load, and RUM events in real time when in debug build.
This widget is intended for debugging and development purposes only and should be removed before shipping to production.
  1. Confirming that RUM Debug Widget it is the official name of the module?

  2. I think the point of this only working in debug and needing to be removed before production is important to list here. What do you think?

Copy link
Author

Choose a reason for hiding this comment

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

Having module is more related to the code itself, here I think we can focus more on the feature, so I wouldn't include that word. Also this can be exceptionally set up in release builds, but this is better explained in the link from this sentence:

See the module README for setup instructions.

This takes us to the configuration of the feature in the code, and I guess it's better just to keep this single source of truth, wdyt?

Copy link
Contributor

@iadjivon iadjivon left a comment

Choose a reason for hiding this comment

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

Hi there,

Thanks for this PR. I've added some changes, please let me know if you have any questions and when this is ready for re-review.

@github-actions
Copy link
Contributor

@kikoveiga kikoveiga requested a review from iadjivon March 17, 2026 23:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants