feat(replays): Define replayId as a deprecated attribute#401
Conversation
Semver Impact of This PR🟡 Minor (new features) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨
🤖 This preview updates automatically when you update the PR. |
SDKs currently send `replayId` on spans, but we'd like to standardize on `sentry.replay_id` (already defined and in use for other telemetry types). Marking it as deprecated lets the product transparently query either name and return results for either attribute.
| "visibility": "public", | ||
| "changelog": [ | ||
| { | ||
| "version": "next" |
There was a problem hiding this comment.
nit: we can link to this PR for reference
| "version": "next" | |
| "version": "next" | |
| "prs": [401] |
There was a problem hiding this comment.
Double-checking - is this necessary? I used to think it was, but it looks like it's actually handled automatically by the generation script (the one that rewrites next into the version number).
sentry-conventions/scripts/generate_attribute_changelog.ts
Lines 289 to 292 in 6ff072d
sentry-conventions/scripts/generate_attribute_changelog.ts
Lines 116 to 140 in 6ff072d
There was a problem hiding this comment.
The generate_attribute_changelog.ts script currently isn't called at release time. AFAIK, this was meant to run manually once but not repeatedly (will check and delete if so). For releases, we only the bump_attribute_changelog.ts script. But this one only does the "next" to {new_version} conversion but doesn't add the PR number. Something we should fix! I'll look into this.
For this PR, no strong feelings. Feel free to merge with or without the PR reference!
There was a problem hiding this comment.
I remembered why generate_attribute_changelog isn't called at release: It takes 5+ minutes locally to run because it looks at every attribute x every single version of conventions to "backfill" PRs and version data from git history. I think we can make this a bit faster for releases by limiting it to "next" entries.
Description
SDKs currently send
replayIdon spans, but we'd like to standardize onsentry.replay_id(already defined and in use for other telemetry types). Marking it as deprecated lets the product transparently query either name and return results for either attribute.PR Checklist
yarn testand verified that the tests pass.yarn generateto generate and format code and docs.