-
Notifications
You must be signed in to change notification settings - Fork 91
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(on-demand): Extend support fields in the event getter #2640
Conversation
/// Width of the screen in pixels. | ||
#[metastructure(pii = "maybe")] | ||
pub screen_width_pixels: Annotated<u64>, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this property having pii make sense? Same for the fields below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought about this, and I was like, maybe some people want to scrape those fields, since they might not want to share that information with sentry (e.g., a new device with a new resolution is being secretly tested), maybe the UUID is the only thing but also that can be delicate for some users. We can definitely omit it, idk if there is a performance overhead to this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rather not mark them PII. They are not, and none of the other fields are marked as such.
The screen size is not PII, however since the other screen attributes are marked as PII, we should stay consistent here.
CHANGELOG.md
Outdated
@@ -12,6 +12,7 @@ | |||
- Restrict resource spans to script and css only. ([#2623](https://github.com/getsentry/relay/pull/2623)) | |||
- Postpone metrics aggregation until we received the project state. ([#2588](https://github.com/getsentry/relay/pull/2588)) | |||
- Scrub random strings in resource span descriptions. ([#2614](https://github.com/getsentry/relay/pull/2614)) | |||
- Extend the number of supported fields for the `Event` `Getter`. ([#2640](https://github.com/getsentry/relay/pull/2640)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR extends the event schema. Could we move this to the features section, and also update the py/changelog?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following fields are missing in this PR:
contexts.app.in_foreground
contexts.unreal.crash_type
I'll rebase #2607 and address these.
/// Width of the screen in pixels. | ||
#[metastructure(pii = "maybe")] | ||
pub screen_width_pixels: Annotated<u64>, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rather not mark them PII. They are not, and none of the other fields are marked as such.
The screen size is not PII, however since the other screen attributes are marked as PII, we should stay consistent here.
screen_dpi: Annotated::new(560), | ||
screen_width_pixels: Annotated::new(1920), | ||
screen_height_pixels: Annotated::new(1080), | ||
locale: Annotated::new("US".into()), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A correct value for this field would be en-US
or de-AT
.
#[metastructure(pii = "maybe")] | ||
pub screen_height_pixels: Annotated<u64>, | ||
|
||
/// Locale of the device. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's try to add more information to the doc comments, such as what is the format. I'll pick this up in my follow-up.
This PR adds support for additional fields in the
Event
Getter
implementation in order to satisfy a wider range of conditions for on-demand metrics.In addition, it adds the following new fields to the
DeviceContext
:Closes getsentry/sentry#58504