Repository navigation
RUM Android: document partial view updates (beta) - #40126
Closed
carlosdelest wants to merge 3 commits into
Closed
carlosdelest wants to merge 3 commits into
carlosdelest wants to merge 3 commits into
Conversation
Adds a section describing how to reduce network usage by opting into incremental view update events via `_RumInternalProxy.setRumViewEventWriteConfig()` with `RumViewEventWriteConfig.FullViewOnlyAtStart`. This is an early-beta, internal API, not yet part of the stable public Configuration.Builder surface. Flagged clearly as such and gated behind contacting Datadog support, matching how other pre-GA/beta options are documented elsewhere on the site.
github-actions
Bot
added
Architecture
Updated warning message about the beta feature for network usage reduction.
_RumInternalProxy.setRumViewEventWriteConfig and RumViewEventWriteConfig are internal, unsupported APIs with no stability guarantee. Link to their definitions on develop (this hasn't shipped in a tagged release yet) instead of only describing them in prose, so the doc can't drift out of sync with the actual signature.
Contributor
|
hey @carlosdelest thanks for the PR! did you want the Android RUM SDK team to take a look before we review it on the docs team? |
Author
|
Closing as we will make this option the default for the next release version |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds a "Reduce network usage with partial view updates" section to the Android RUM advanced configuration page, describing how to opt in via
_RumInternalProxy.setRumViewEventWriteConfig()withRumViewEventWriteConfig.FullViewOnlyAtStart.Motivation
We want customers who are willing to try an early-beta option to be able to find and use it, with an accurate description of its current state.
Important — please review carefully
This documents an internal-only API.
_RumInternalProxyandRumViewEventWriteConfigboth carry explicit "DO NOT USE unless working on Datadog SDK internals" doc comments in the dd-sdk-android source, andRumConfiguration.Builder.setRumViewEventWriteConfig(the method the proxy delegates to) is Kotlininternal, not part of the stable public API surface.This PR is opened at the explicit request of a team building a customer-facing nudge for this feature, who confirmed they want it documented despite the SDK's current internal-only status. I'd like the Android RUM SDK team to weigh in before this merges — if internal-only status should remain enforced (not just documented as "beta"), please close this PR rather than merge it, or let me know what documentation approach would be appropriate instead. I gated the section behind a warning alert directing readers to contact Datadog support first, but that may not be sufficient mitigation.