Skip to content

Comments

docs(sdk): migrate profiles spec to standard format, deprecate V1#16480

Merged
stephanie-anderson merged 2 commits intomasterfrom
sdk/spec-format-profiles
Feb 20, 2026
Merged

docs(sdk): migrate profiles spec to standard format, deprecate V1#16480
stephanie-anderson merged 2 commits intomasterfrom
sdk/spec-format-profiles

Conversation

@stephanie-anderson
Copy link
Contributor

@stephanie-anderson stephanie-anderson commented Feb 20, 2026

Migrate the profiles spec (develop-docs/sdk/telemetry/profiles/) to the standard spec format and deprecate V1 transaction-based profiling in favor of V2 continuous profiling.

Consolidation: 4 files merged into one spec document:

  • index.mdx (was a shell with <PageGrid />)
  • sample-format-v1.mdx → Wire Format: V1 sections (now deprecated)
  • sample-format-v2.mdx → Wire Format: V2 sections
  • continuous-profiling-api.mdx → Public API section

Versioning: 12 versions (1.0.0–2.5.0) derived from git history:

  • 1.x = V1 transaction-based profiling era (2023-03)
  • 2.0.0 = V2 continuous profiling format introduced (2024-09)
  • 2.5.0 = V1 deprecated in favor of V2 (2026-02)

Deprecation: V1 sections marked status="deprecated" with superseded_by references to V2 equivalents. Overview and Concepts updated to direct all new SDK work to V2.

16 SpecSections: sampling-frequency, profile-lifecycle-modes, tracing-context-linking, v1-sample-format (deprecated), v2-sample-format, profile-data, v1-validation (deprecated), v2-validation, v1-envelope (deprecated), v2-envelope, tracing-context-payload, profile-session-sample-rate, profile-lifecycle, start-profiler-on-app-start, start-profiler, stop-profiler

Other changes:

  • Redirects added for 3 deleted child pages
  • Internal link updated in envelope-items.mdx

Co-Authored-By: Claude noreply@anthropic.com

Consolidate 4 profile spec files (index, sample-format-v1,
sample-format-v2, continuous-profiling-api) into a single spec
with proper versioning derived from git history (12 versions,
1.0.0–2.5.0). Mark V1 transaction-based profiling as deprecated
in favor of V2 continuous profiling.

- 16 SpecSections with per-section status and since annotations
- V1 sections marked deprecated with superseded_by references
- Redirects for deleted child pages
- Updated internal link in envelope-items.mdx

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Feb 20, 2026 9:40am
sentry-docs Ready Ready Preview, Comment Feb 20, 2026 9:40am

Request Review

Copy link
Contributor

@dingsdax dingsdax left a comment

Choose a reason for hiding this comment

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

nice, only suggestion for future improvement, if multiple versions exist, like here with v1 and v2, I think a tabbed interface would work better

@stephanie-anderson stephanie-anderson merged commit c6ef5dd into master Feb 20, 2026
17 checks passed
@stephanie-anderson stephanie-anderson deleted the sdk/spec-format-profiles branch February 20, 2026 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants