RUM: document account.* attributes for the mobile SDKs - #39382
Open
qsellem wants to merge 1 commit into
Open
Conversation
The account APIs (setAccountInfo / addAccountExtraInfo / clearAccountInfo) shipped in the mobile SDKs in June 2025 but were only documented for the Browser SDK. Add a "Track user accounts" section, mirroring the Browser page's Account section, to the Advanced Configuration partials for the platforms whose SDKs expose the API: - iOS (2.29.0), Android (2.23.0), Flutter (2.12.0), React Native (3.0.0), Kotlin Multiplatform (1.2.0) Also: - MAUI already documented the API; add the missing attribute table and align the heading with the other platforms. - C++ documented the attributes as `acc.id` / `acc.name`, but the SDK serializes an `account` object, so the queryable attributes are `account.id` / `account.name`. Corrected. Unity and Roku expose no account API, so they are unchanged. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
qsellem
marked this pull request as ready for review
August 21, 2026 11:26
Contributor
|
Created DOCS-15499 for editorial review. |
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
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? What is the motivation?
The SDK-level account APIs (
setAccountInfo/addAccountExtraInfo/clearAccountInfo) shipped in the mobile SDKs in June 2025, butaccount.*is only documented for the Browser SDK. Customers on mobile currently have no way to discover the feature — the only mention anywhere in the English docs is an incidental mock-SDK snippet on the Expo page.This PR adds a
### Track user accountssection next to the existing### Track user sessionssection in Advanced Configuration, mirroring the Browser page's## Accountsection, for every platform whose SDK actually exposes the API:Datadog.setAccountInfo(id:name:extraInfo:)Datadog.setAccountInfo(id, name, extraInfo)DatadogSdk.instance.setAccountInfo(...)DdSdkReactNative.setAccountInfo({...})Datadog.setAccountInfo(id, name, extraInfo)Each section documents the
account.id/account.nameattributes, the set → append → clear lifecycle, thatextraInfokeys are reported underaccount.<key>, thataddAccountExtraInfobeforesetAccountInfois a no-op, and that clearing emptiesaccounton the active session and view (stop them first to retain it).Two related fixes in the same area:
Track account sessionstoTrack user accountsfor consistency with the other platforms.acc.id/acc.name, but the SDK serializes anaccountobject (logging.hpp#L42,crash_handling.cpp#L118), so the queryable attributes areaccount.id/account.name. A customer following the current page would query on an attribute that does not exist.All API names, signatures, versions, and behavior notes were verified against the SDK source, not inferred from the Browser docs.
Merge readiness
For Datadog employees:
AI assistance
Used Claude Code to cross-check each SDK's source for API availability, exact signatures, and introduction versions, and to draft the sections. Reviewed manually.
Additional notes
Deliberately out of scope, but worth flagging for the owning teams:
Track user sessionsbut the Unity SDK exposes no account API at all (onlySetUserInfo). That's an SDK gap, not a docs one. Roku likewise has no account API.tracing/guide/users-accounts.mdsays user and account info can be propagated from "browser or mobile" applications, then gives only the browser APIs.product_analytics/profiles/_index.mdpoints only atdatadogRum.setAccount, so mobile-only customers can't tell Account Profiles apply to them.data_collectedpages don't listaccount.*among collected attributes.Happy to fold any of these in if reviewers prefer them here rather than as follow-ups.