Add RUM Debug Widget to troubleshooting.md#35347
Conversation
| Datadog.setVerbosity(Log.INFO) | ||
| ``` | ||
|
|
||
| ## RUM Debug Widget |
There was a problem hiding this comment.
| ## 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.
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
| 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. | |
-
Confirming that RUM Debug Widget it is the official name of the module?
-
I think the point of this only working in
debugand needing to be removed before production is important to list here. What do you think?
There was a problem hiding this comment.
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?
content/en/real_user_monitoring/application_monitoring/android/troubleshooting.md
Show resolved
Hide resolved
iadjivon
left a comment
There was a problem hiding this comment.
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.
Preview links (active after the
|
What does this PR do? What is the motivation?
Merge instructions
Merge readiness:
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.