Skip to content

docs(python): Draft New Spans and Migration Guide pages#18456

Draft
inventarSarah wants to merge 3 commits into
masterfrom
smi/span-first/python
Draft

docs(python): Draft New Spans and Migration Guide pages#18456
inventarSarah wants to merge 3 commits into
masterfrom
smi/span-first/python

Conversation

@inventarSarah

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

This PR adds the initial docs for Python span streaming: a New Spans page (intro to stream mode) and a Migration Guide (how to update existing custom instrumentation).

Context
For Python, the new Span API and stream mode ship together, so migrating to stream mode means migrating to the new Span API at the same time abd there's no way to use the new API while staying in transaction mode.
Because of that, putting the migration steps into the New Spans was way too much content and I split that content out into a new Migration guide. This guide is basically a human-readable version of the migration content from the engineering skill file.

Considerations

  • Content here may still change once I go through the existing Tracing, Option, Filtering, etc. pages
  • The Migration Guide is currently nested under New Spans in the nav. But it could also live under the main "Migration Guides" section instead. Let me know if it makes sense to move the guide.
  • I reused content from the JS New Spans page -> I will create includes for these later when the content is fixed :)

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel

vercel Bot commented Jun 17, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jun 17, 2026 9:29am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Jun 17, 2026 9:29am

Request Review

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.

1 participant