docs(python): update integrations for stream mode by inventarSarah · Pull Request #18526 · getsentry/sentry-docs

inventarSarah · 2026-06-24T07:57:16Z

DESCRIBE YOUR PR

This PR contains the updated integration docs for stream mode.

what I did:

added a callout (include) at the top about stream mode
added a callout (include) under the Options heading
added an inline comment when start_transaction is used

I decided to add callouts rather than make direct edits to each integration file.
I still need to update the integration files to match our new quick start guide format -> could update the stream mode docs then too

Important

Broken links: I added links to the New Spans guide on these pages, but since this guide does not exist in this branch, we get a linting error.
Should only be merged after #18456

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

Sentry Docs contributor guide

vercel · 2026-06-24T07:57:22Z

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

Project	Deployment	Actions	Updated (UTC)
sentry-docs	Ready	Preview, Comment	Jul 2, 2026 8:15pm

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
develop-docs	Ignored	Preview	Jul 2, 2026 8:15pm

alexander-alderman-webb

Thanks looks good! A few more occurrences of diverging names that I didn't call out

alexander-alderman-webb · 2026-06-25T09:39:24Z

+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
    with sentry_sdk.start_transaction(name="The result of the AI inference"):


Doesn't really matter but I think the names should be aligned here

Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="The result of the AI inference"):

# or sentry_sdk.traces.start_span(name="The result of the AI inference", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="The result of the AI inference"):

alexander-alderman-webb · 2026-06-25T09:39:47Z

+        # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
        with sentry_sdk.start_transaction(name="testing_sentry"):


Doesn't really matter but I think the names should be aligned here

Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

alexander-alderman-webb · 2026-06-25T09:40:03Z

+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
    with sentry_sdk.start_transaction(name="testing_sentry"):


Doesn't really matter but I think the names should be aligned here

Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

alexander-alderman-webb · 2026-06-25T09:40:20Z

+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
    with sentry_sdk.start_transaction(name="testing_sentry"):


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

alexander-alderman-webb · 2026-06-25T09:40:46Z

    with sentry_sdk.start_transaction(name="calling-a-celery-task"):
+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode


Suggested change

with sentry_sdk.start_transaction(name="calling-a-celery-task"):

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="calling-a-celery-task"):

# or sentry_sdk.traces.start_span(name="calling-a-celery-task", parent_span=None) in stream mode

alexander-alderman-webb · 2026-06-25T09:41:34Z

+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
    with sentry_sdk.start_transaction(name="The result of the AI inference"):


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="The result of the AI inference"):

# or sentry_sdk.traces.start_span(name="The result of the AI inference", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="The result of the AI inference"):

alexander-alderman-webb · 2026-06-25T09:41:45Z

+# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
 with sentry_sdk.start_transaction(op="function", name="testing_sentry"):


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(op="function", name="testing_sentry"):

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

with sentry_sdk.start_transaction(op="function", name="testing_sentry"):

alexander-alderman-webb · 2026-06-25T09:42:30Z

+        # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
        with sentry_sdk.start_transaction(name="testing_sentry"):


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

alexander-alderman-webb · 2026-06-25T09:42:40Z

+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
    with sentry_sdk.start_transaction(name="testing_sentry"):


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

alexander-alderman-webb · 2026-06-25T09:42:50Z

+# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
 with sentry_sdk.start_transaction(name="testing_sentry"):


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

with sentry_sdk.start_transaction(name="testing_sentry"):

ericapisani · 2026-06-25T13:09:13Z

 def divide(a, b):
    return a/b

+# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode


Similar to the other naming consistency comments that Alex has left elsewhere

Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

# or sentry_sdk.traces.start_span(name="ray-test", parent_span=None) in stream mode

ericapisani · 2026-06-25T13:09:24Z

    sentry_sdk.init(...)  # same as above
    r = redis.Redis(host='localhost', port=6379, decode_responses=True)

+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

ericapisani · 2026-06-25T13:09:32Z

    sentry_sdk.init(...)  # same as above
    rc = RedisCluster(host='localhost', port=16379)

+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

ericapisani · 2026-06-25T13:09:41Z

    sentry_sdk.init(...)  # same as above
    r = redis.Redis(host='localhost', port=6379)

+    # or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode


Suggested change

# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode

# or sentry_sdk.traces.start_span(name="testing_sentry", parent_span=None) in stream mode

sentrivana

Lgtm! Agree with the others that it'd be nice to keep the span names consistent though.

… review suggestions - Resolve merge conflicts in 8 files (asgi, aws-lambda, grpc, ray, rq, sanic, socket, wsgi) keeping master's updated profiling URL (/product/profiling/) - Apply reviewer suggestions: align stream mode span names with start_transaction names across anthropic, aiomysql, arq, asyncpg, celery, google-genai, grpc, sqlalchemy, socket, rq, ray, and redis integrations

sentry · 2026-07-01T21:15:27Z

 client = Anthropic(api_key="(your Anthropic key)")

 def my_llm_stuff():
+    # or sentry_sdk.traces.start_span(name="The result of the AI inference", parent_span=None) in stream mode


Bug: The documentation incorrectly references sentry_sdk.traces.start_span() instead of the correct public API sentry_sdk.start_span(), which will cause an AttributeError for users.
_{Severity: HIGH}

Suggested Fix

Replace all occurrences of sentry_sdk.traces.start_span() in the documentation comments with the correct API call, sentry_sdk.start_span(). The public API for creating spans is the same regardless of whether stream mode is enabled.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: docs/platforms/python/integrations/anthropic/index.mdx#L45 Potential issue: The documentation comments in several Python integration files incorrectly suggest using `sentry_sdk.traces.start_span()` to create a span in stream mode. This is not a valid public API. The correct function is `sentry_sdk.start_span()`. Users who copy this example code and enable stream mode will encounter an `AttributeError` when their code attempts to call the non-existent function, causing their application to fail. This incorrect guidance is present in multiple locations, affecting integrations like Anthropic, Celery, RQ, gRPC, Ray, and OpenAI.

Also affects:

docs/platforms/python/integrations/celery/index.mdx:116

docs/platforms/python/integrations/rq/index.mdx:182~183

docs/platforms/python/integrations/grpc/index.mdx:147~148

docs/platforms/python/integrations/ray/index.mdx:93

docs/platforms/python/integrations/openai/index.mdx:53

_{Did we get this right? 👍 / 👎 to inform future reviews.}

inventarSarah requested review from alexander-alderman-webb, cleptric, ericapisani, sentrivana and sfanahata June 24, 2026 07:57

vercel Bot deployed to Preview – sentry-docs June 24, 2026 07:58 View deployment

update integration docs for stream mode

8e5d8e1

inventarSarah force-pushed the smi/span-first/python-integrations branch from b09e983 to 8e5d8e1 Compare June 24, 2026 11:49

inventarSarah marked this pull request as ready for review June 24, 2026 11:50

vercel Bot deployed to Preview – sentry-docs June 24, 2026 12:00 View deployment

alexander-alderman-webb approved these changes Jun 25, 2026

View reviewed changes

ericapisani reviewed Jun 25, 2026

View reviewed changes

ericapisani approved these changes Jun 25, 2026

View reviewed changes

sentrivana approved these changes Jun 29, 2026

View reviewed changes

buenaflor mentioned this pull request Jul 1, 2026

docs(dart): Add stream mode callout to integration pages #18610

Draft

6 tasks

sentry Bot reviewed Jul 1, 2026

View reviewed changes

vercel Bot deployed to Preview – develop-docs July 1, 2026 21:18 View deployment

vercel Bot deployed to Preview – sentry-docs July 1, 2026 21:28 View deployment

rename 'New Spans' references to 'Streamed Spans'

637ee9d

vercel Bot deployed to Preview – sentry-docs July 2, 2026 20:15 View deployment

		# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
		with sentry_sdk.start_transaction(name="The result of the AI inference"):

		# or sentry_sdk.traces.start_span(name="your_span_name", parent_span=None) in stream mode
		with sentry_sdk.start_transaction(op="function", name="testing_sentry"):

Uh oh!

Uh oh!

Conversation

inventarSarah commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

LEGAL BOILERPLATE

EXTRA RESOURCES

Uh oh!

vercel Bot commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alexander-alderman-webb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sentrivana left a comment

Choose a reason for hiding this comment

Uh oh!

sentry Bot Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

inventarSarah commented Jun 24, 2026 •

edited

Loading

vercel Bot commented Jun 24, 2026 •

edited

Loading