docs(js): remove misleading claim about arbitrary user key/value pairs#17800
Open
sentry-junior[bot] wants to merge 1 commit into
Open
docs(js): remove misleading claim about arbitrary user key/value pairs#17800sentry-junior[bot] wants to merge 1 commit into
sentry-junior[bot] wants to merge 1 commit into
Conversation
The setUser docs stated that arbitrary key/value pairs could be added to the User object. In practice, these arbitrary values do not appear in the Sentry UI (e.g. under tags), making this guidance misleading. Remove the sentence to avoid confusion. Users should rely on the defined User fields (id, email, username, ip_address). Ref: getsentry/sentry#58767
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
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.
Summary
Remove the sentence claiming that arbitrary key/value pairs can be added to the
Userobject insetUser. In practice, these values don't surface in the Sentry UI (e.g. as tags), making this guidance misleading.Users should rely on the defined User fields (
id,email,username,ip_address).References
Note
There are ~20 similar sentences across other platform
identify-userpages (Android, Python, Go, etc.). This PR scopes to the JS API reference as requested — a broader cleanup could follow.Requested-by: Francesco Gringl-Novy <@U0464NED8ER>