Skip to content

feat: Add a script to generate deprecated attributes#61

Merged
shruthilayaj merged 7 commits intomainfrom
shruthi/feat/generate-deprecated-attrs-json
May 28, 2025
Merged

feat: Add a script to generate deprecated attributes#61
shruthilayaj merged 7 commits intomainfrom
shruthi/feat/generate-deprecated-attrs-json

Conversation

@shruthilayaj
Copy link
Member

@shruthilayaj shruthilayaj commented May 26, 2025

Adds a script to generate a JSON of deprecated fields
so the ingest pipeline can use sentry-conventions
as the source of truth.

Also adds a _status field to the attributes schema.
We can use this internally do decide which stage of the
deprecation an is in. Deprecated fields need a 90 day
backfill (ie relay double-writes, EAP coalesces etc) after
which they can just be normalized to the new field.

@shruthilayaj shruthilayaj marked this pull request as ready for review May 26, 2025 16:44
Comment on lines +11 to +12
"replacement": "http.response.size",
"_status": "backfill"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If an SDK is sending http.response.size (the already 'correct' field), would we also write http.response_transfer_size?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops, no - we'd only write it to http.response.size - the coalesce should take care of it

"reason": {
"type": "string"
},
"_status": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be required? If not it effectively communicates a third enum value.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought we'd start the double write with a small set of deprecated fields, so just have relay do nothing for the rest, but should we just start double write on all of these @Dav1dde

Copy link
Member

@Dav1dde Dav1dde May 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 that answer my question as well, for a missing _status we just do nothing!

Idea: rename status to normalize with values replace, backfill, None (do nothing, default)? But that's just bikeshedding.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, let me do that - i'll add a third option and make it required so it's explicit

@shruthilayaj shruthilayaj merged commit f92acac into main May 28, 2025
5 checks passed
@shruthilayaj shruthilayaj deleted the shruthi/feat/generate-deprecated-attrs-json branch May 28, 2025 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants