search

getsentry / sentry-docs

Sentry's documentation (and tools to build it)
https://docs.sentry.io
Other
332 stars 1.46k forks source link

`SentryUser.data` not described #10969

Open lhunath opened 3 months ago

lhunath commented 3 months ago

Core or SDK?

Platform/SDK

Which part? Which one?

https://docs.sentry.io/platforms/apple/enriching-events/identify-user/

Description

The document does not detail the SentryUser.data property, whether it has any default values or not, whether data added to this property may or may not conflict with existing user data (eg. can I use keys such as user_id and name?), how this data will be surfaced in the Sentry events, whether it will participate in user or custom tags, whether it will be searchable, etc.

Suggested Solution

Expand the relevant documentation at https://docs.sentry.io/platforms/apple/enriching-events/identify-user/

The documentation at the API level is also a bit meager.

/**
 * Optional: Additional data
 */
@property (atomic, strong) NSDictionary<NSString *, id> *_Nullable data;
getsantry[bot] commented 3 months ago

Assigning to @getsentry/support for routing ⏲️