Repository navigation
docs(data-collection): Define the installation identifier - #20856
Merged
Merged
Conversation
SDKs disagree on whether `userInfo` gates the installation ID they send as `user.id`. Write down that `dataCollection` options don't gate it and that SDKs must generate it at random instead of deriving it from hardware or system values. Bump the spec to 0.18.0.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
ric-oliv
marked this pull request as ready for review
November 17, 2026 15:16
Contributor
|
Getting ready to monitor this change · Rollout details
|
SDKs should generate the installation identifier at random, but some platforms provide a stable, pseudonymous ID scoped to the app. Allow those, and only rule out values that identify the device outside the app, such as a MAC address or a host name.
chargome
approved these changes
Nov 17, 2026
jamescrosswell
added a commit
to getsentry/sentry-dotnet
that referenced
this pull request
Nov 17, 2026
With UserInfo disabled the enricher skips the whole block, so the old test never exercised the HasUser() check. Running it with UserInfo both on and off, and no username set, catches a dropped HasUser() check or a switch to `Username ??=`. Also note on DataCollectionOptions.UserInfo that the installation ID still fills SentryUser.Id, per getsentry/sentry-docs#20856. Refs #5428 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
philprime
approved these changes
Nov 18, 2026
JoshuaMoelans
approved these changes
Nov 18, 2026
This branch was successfully deployed
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.
DESCRIBE YOUR PR
The data collection spec doesn't say whether
userInfocovers the installation ID that some SDKs generate and send asuser.id, so SDKs have read it both ways. Java keeps the ID independent ofuserInfoin getsentry/sentry-java#5937, and Cocoa's v10 builds gate it in getsentry/sentry-cocoa#8415. .NET has to pick one in getsentry/sentry-dotnet#5932.This PR adds an "Installation Identifier" section that writes down what Java does:
dataCollectionoptions don't gate the installation identifier. It identifies an installation, not a person.It also points the
userInforow, the "Disable User Identity" example and the technical context examples at the new section. The section adds requirements, so the spec moves to 0.18.0.Why Java's reading:
userInfo: falseto roughly matchsendDefaultPii: false, andsendDefaultPii: falsealways sent the installation ID.user.iddoesn't keep the ID on the device, because sessions send the same value asdid. It would drop the "users affected" counts and protect very little.I also considered gating it on
userInfo, the way Cocoa v10 does. That would need a rule for the sessiondidtoo, and it would change behavior in every shipped SDK.For the SDKs, Java already follows this, Cocoa would drop the
SDK_V10gate before v10 ships, and .NET will follow up on its side.IS YOUR CHANGE URGENT?