Skip to content

RUM-17548: Document Android RUM view memory attributes #38674

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
jonathanmos wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −0
Open

RUM-17548: Document Android RUM view memory attributes #38674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions layouts/shortcodes/mdoc/en/sdk/data_collected/android.mdoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,22 @@ RUM action, error, resource, and long task events contain information about the
| `view.is_active` | Boolean | Indicates whether the view corresponding to this event is considered active. |
| `view.loading_time` | number (ns) | Time it took for the view to load, set by the `addViewLoadingTime(override:)` call. |
| `view.long_task.count` | number | Count of all long tasks collected for this view. |
| `view.memory_average` | number (bytes) | Exact arithmetic mean of successful process resident memory samples collected during this view. |

@melamos melamos Aug 3, 2026

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
| `view.memory_average` | number (bytes) | Exact arithmetic mean of successful process resident memory samples collected during this view. |
| `view.memory_average` | number (bytes) | Exact arithmetic mean of successful whole-process resident memory samples collected while this view is foregrounded. |

| `view.memory_max` | number (bytes) | Largest successful process resident memory sample collected during this view. |

@melamos melamos Aug 3, 2026

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
| `view.memory_max` | number (bytes) | Largest successful process resident memory sample collected during this view. |
| `view.memory_max` | number (bytes) | Largest successful whole-process resident memory sample collected while this view is foregrounded. |

| `view.name` | string | Customizable name of the view corresponding to the event. |
| `view.network_settled_time` | number (ns) | Time it took for a view to be fully loaded with all relevant network calls initiated at the start of the view. |
| `view.resource.count` | number | Count of all resources collected for this view. |
| `view.time_spent` | number (ns) | Time spent on this view. |
| `view.url` | string | Canonical name of the class corresponding to the event. |

#### View memory collection

The Android SDK reads the `VmRSS` value from `/proc/self/status`. This value measures resident memory for the entire application process. It includes native memory, the JVM or Android Runtime (ART) heap, and resident shared pages.

@melamos melamos Aug 3, 2026

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.

JVM isn't on the abbreviation exempt list and isn't spelled out elsewhere in this file — spell out on first mention.

Suggested change
The Android SDK reads the `VmRSS` value from `/proc/self/status`. This value measures resident memory for the entire application process. It includes native memory, the JVM or Android Runtime (ART) heap, and resident shared pages.
The Android SDK reads the `VmRSS` value from `/proc/self/status`. This value measures resident memory for the entire application process. It includes native memory, the Java Virtual Machine (JVM) or Android Runtime (ART) heap, and resident shared pages.


Each view tracks the exact running mean and maximum of successful samples. These calculations are neither exponential nor windowed. The SDK resets both calculations for each view.

@melamos melamos Aug 3, 2026

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
Each view tracks the exact running mean and maximum of successful samples. These calculations are neither exponential nor windowed. The SDK resets both calculations for each view.
Each view tracks the exact running mean and maximum of successful samples. Calculations reset when the view starts, so they reflect only the samples collected during that view, not a rolling average carried over from previous views.


By default, the SDK samples memory every 500 ms (`VitalsUpdateFrequency.AVERAGE`) while the view is in the foreground. Use [`RumConfiguration.setVitalsUpdateFrequency`][14] to change the frequency or disable collection with `VitalsUpdateFrequency.NEVER`. If the SDK cannot read `/proc/self/status`, it skips that sample without reporting an error.

### View accessibility attributes

Accessibility attribute collection is disabled by default. To enable it, call `collectAccessibility(true)` on your `RumConfiguration.Builder`:
Expand Down Expand Up @@ -280,3 +290,4 @@ The RUM Android SDK allows you to get the data you need to Datadog while conside
[11]: /data_security/real_user_monitoring/#ip-address
[12]: https://source.android.com/security/app-sandbox
[13]: https://developer.android.com/training/articles/direct-boot
[14]: /real_user_monitoring/application_monitoring/android/advanced_configuration/#initialization-parameters
Loading