-
-
Notifications
You must be signed in to change notification settings - Fork 1
feat: Remove unused fields from subscription results #88
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
Conversation
Whilst creating this schema and integrating it into Snuba and Sentry we discovered there were some fields ("profile" and "trace_output") being published that were essentially internal Snuba data and are completely unused by Sentry. Let's remove them from the schema and example. Since "additionalProperties" is true, this is a backward compatible change and old messages still in the pipeline will not fail validation.
This pull request contains the following schema changes # schemas/subscription-results.v1.schema.json
!!! WARNING: changes considered breaking:
## Removed the property .payload.result, so it is no longer accepted. Maybe use additionalProperties?
{"path": ".payload.result", "change": {"PropertyRemove": {"lhs_additional_properties": false, "removed": "profile"}}}
## Removed the property .payload.result, so it is no longer accepted. Maybe use additionalProperties?
{"path": ".payload.result", "change": {"PropertyRemove": {"lhs_additional_properties": false, "removed": "trace_output"}}} |
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'm not particularly against removing this, but I think extra data was included so we could log if needed for debugging. If this isn't that useful for debugging I'm happy to remove though.
Thanks for the context, I did not realise it was intentional. Looking at getsentry/sentry#46647 I don't think it would be logged anywhere (at least after this PR) since it's immediately transformed to a |
Happy to close this and leave them in if you think that's best, i just assumed it was internal snuba stuff |
Fix false-positive breaking change in getsentry/sentry-kafka-schemas#88
I don't feel too strongly either way, I'm not even sure if this info is useful for debugging. I'll leave it up to you, we can always add it back in later if we need it for some reason |
Since neither of us feel too strongly, I think we should merge this. Reasons:
|
Whilst creating this schema and integrating it into Snuba and Sentry we discovered there were some fields ("profile" and "trace_output") being published that were essentially internal Snuba data and are completely unused by Sentry in the results consumer. Let's remove them from the schema and example.
Since "additionalProperties" is true, this is a backward compatible change and old messages still in the pipeline will not fail validation.