RUM iOS: document the featureFlags initialization parameter - #40125
Closed
carlosdelest wants to merge 6 commits into
Closed
carlosdelest wants to merge 6 commits into
carlosdelest wants to merge 6 commits into
Conversation
`RUM.Configuration.featureFlags` (available since dd-sdk-ios 3.17.0) was missing from the Initialization parameters reference, including the new `.viewUpdates` flag that reduces network usage by sending incremental view update deltas instead of full view events.
github-actions
Bot
added
Architecture
Adds a note next to the featureFlags parameter clarifying that individual flags (such as .viewUpdates) may be beta functionality, and that their behavior can change in future SDK releases without following semantic versioning.
Clarified feature flags description and updated warning about beta functionality.
maxep
reviewed
Sep 22, 2026
Comment on lines
+343
to
+345
| Available since SDK 3.17.0: | ||
| - `.trackScrollAndSwipeActions`: When set to `false`, disables automatic scroll and swipe action tracking performed by the SDK. Enabled (`true`) by default. Disabling it also means these gestures no longer count as candidate "last interactions" for Interaction-to-Next-View (INV) attribution. | ||
| - `.viewUpdates`: (beta) When set to `true`, changes how view updates are reported. After the first full view event for a view, subsequent updates are sent as delta events containing only the fields that changed, instead of resending the full event. A full event is still sent every 5 updates so the view state can be reconstructed even if some deltas are lost in transit. Disabled (`false`) by default. |
Member
There was a problem hiding this comment.
Feature Flags come and go, it would be best not to list them in doc but rather ask to refer to the code for the complete list
Member
There was a problem hiding this comment.
Also, trackScrollAndSwipeActions was added prior to that. If we want to highlight viewUpdates, we can keep that one only
Feature flags come and go as they graduate to GA or get replaced, so enumerating them by hand in docs goes stale quickly. Point readers to the RUM.Configuration.FeatureFlag enum in the SDK source instead, which is always current.
…hub.com:DataDog/documentation into carlos.delgado/rum-ios-partial-view-updates-doc # Conflicts: # hugo/layouts/shortcodes/mdoc/en/sdk/advanced_config/ios.mdoc.md
rtrieu
self-requested a review
September 22, 2026 15:32
rtrieu
reviewed
Sep 22, 2026
rtrieu
reviewed
Sep 22, 2026
| `featureFlags` | ||
| : A dictionary of feature flags used to opt in to specific RUM behaviors, available since SDK 3.17.0. Because flags are added and removed as they graduate or get replaced, see the [`RUM.Configuration.FeatureFlag` definition][11] in the SDK source for the complete, current list of available flags and their behavior. | ||
|
|
||
| {% alert level="warning" %} |
Collaborator
There was a problem hiding this comment.
let's remove this warning since we're adding the Preview annotation
Removed warning alert about beta feature flags and updated documentation for featureFlags.
maxep
approved these changes
Sep 22, 2026
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
3 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
featureFlagsto the iOS RUM "Initialization parameters" reference, including the.viewUpdatesflag added in dd-sdk-ios 3.17.0.Motivation
RUM.Configuration.featureFlagsexists as a public, released API (confirmed present in the 3.17.0 tag, absent in 3.16.0) but wasn't listed in the alphabetical parameter glossary on this page, even though every otherRUM.Configurationproperty is. Customers currently have no way to discover.viewUpdates— which reduces network usage by sending incremental view update deltas instead of resending a full view event on every update — from the docs site.Additional notes
The SDK's own
RUM_FEATURE.mdalready documents this internally; this PR brings the same information to the public docs site.