Skip to content

Commit d7d2cec

Browse files
JoshuaMoelanskahestcoolguyzone
authored
chore: clarify user context UI and interface (#13620)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> [Vercel Preview](https://develop-docs-bmq9r90m3.sentry.dev/sdk/data-model/event-payloads/user/) ## DESCRIBE YOUR PR Related to getsentry/sentry#90993 , where we added the prefix `data.` to all unknown User Context keys, making them stand out in the UI. It was confusing to some users that the UI showed the User data in a "prettified" manner, not matching the expected keys sent from the SDKs, so I'm adding some warnings/notes to the develop docs to clear this up. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Karl Heinz Struggl <kahest@users.noreply.github.com> Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
1 parent dd364bf commit d7d2cec

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

  • develop-docs/sdk/data-model/event-payloads

develop-docs/sdk/data-model/event-payloads/user.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ You should provide at least one of `id`, `email`, `ip_address`,
1010
affected by one issue, for example. Sending a user that has none
1111
of these attributes and only custom attributes is valid, but not as useful.
1212

13+
<Alert title="Note" level="warning">
14+
These keys are case-sensitive, any mistyped keys will be processed as custom attributes.
15+
</Alert>
16+
1317
## Attributes
1418

1519
`id`
@@ -31,6 +35,10 @@ of these attributes and only custom attributes is valid, but not as useful.
3135
All other keys are stored as extra information but not specifically processed by
3236
Sentry.
3337

38+
<Alert title="Note">
39+
The titles of these well-known attributes are prettified in the UI. For example, `ip_address` is shown as `IP Address`. Other keys are shown as they were sent, with the prefix `data.`.
40+
</Alert>
41+
3442
`geo`
3543

3644
: An optional object describing the [geographical location](#geographical-location) of the end user or device, this object is automatically inferred by Relay if `ip_address` is provided.

0 commit comments

Comments
 (0)