RUM-17548: Document Android RUM view memory attributes - #38674
RUM-17548: Document Android RUM view memory attributes#38674jonathanmos wants to merge 1 commit into
Conversation
melamos
left a comment
There was a problem hiding this comment.
Thanks for documenting this – seems like exactly what the support escalation needed. Added a few line-level suggestions: spell out JVM on first mention, and some minor wording tweaks to the memory_average/memory_max definitions and the per-view reset explanation for clarity.
|
|
||
| #### 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. |
There was a problem hiding this comment.
JVM isn't on the abbreviation exempt list and isn't spelled out elsewhere in this file — spell out on first mention.
| 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. |
| | `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. | |
There was a problem hiding this comment.
| | `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.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. | | ||
| | `view.memory_max` | number (bytes) | Largest successful process resident memory sample collected during this view. | |
There was a problem hiding this comment.
| | `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. | |
|
|
||
| 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. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
| 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. |
melamos
left a comment
There was a problem hiding this comment.
Approving to unblock merge — see my earlier review for a few non-blocking wording suggestions.
brett0000FF
left a comment
There was a problem hiding this comment.
+1 to Melissa's review comments. Thanks!
What does this PR do? What is the motivation?
Documents the Android RUM
view.memory_averageandview.memory_maxattributes. This update explains what memory they measure, how the SDK calculates them, the default sampling frequency, configuration options, and collection limitations.This information helps users interpret view memory data and account for sampling behavior when analyzing application performance.
Merge readiness
AI assistance
Codex assisted PR.