Skip to content

Add RUM Debug Widget to troubleshooting.md #35347

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

Open
kikoveiga wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add RUM Debug Widget to troubleshooting.md #35347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01ca208
Add RUM Debug Widget to troubleshooting.md
kikoveiga Mar 17, 2026
958585c
Apply review suggestions
kikoveiga Mar 17, 2026
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
10 changes: 10 additions & 0 deletions content/en/real_user_monitoring/application_monitoring/android/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@
Datadog.setVerbosity(Log.INFO)
```

## RUM Debug Widget

Check warning on line 36 in content/en/real_user_monitoring/application_monitoring/android/troubleshooting.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.headings 

'RUM Debug Widget' should use sentence-style capitalization.
Copy link
Contributor

@iadjivon iadjivon Mar 17, 2026 •
edited
Loading

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

@kikoveiga kikoveiga Mar 17, 2026

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.


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 •
edited
Loading

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

@kikoveiga kikoveiga Mar 17, 2026

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?


See the [module README][6] for setup instructions.

{{< img src="real_user_monitoring/android/android-rum-debug-widget.png" alt="RUM Debug Widget floating overlay" style="width:50%;">}}

## Migrating to 3.0.0

If you've been using the SDK v2 or SDK v1, there are some breaking changes introduced in version `3.0.0`. See the [migration guide][2] for more information.
Expand All @@ -49,3 +57,5 @@
[2]: /real_user_monitoring/guide/mobile-sdk-upgrade
[3]: https://app.datadoghq.com/source-code/setup/rum
[4]: /real_user_monitoring/guide/debug-symbols
[5]: https://github.com/DataDog/dd-sdk-android/tree/develop/features/dd-sdk-android-rum-debug-widget
[6]: https://github.com/DataDog/dd-sdk-android/blob/develop/features/dd-sdk-android-rum-debug-widget/README.md
Binary file added static/images/real_user_monitoring/android/android-rum-debug-widget.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading