Skip to content

docs: Update span streaming docstrings #7463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sentrivana merged 2 commits into from
Sep 11, 2026
Merged

docs: Update span streaming docstrings #7463

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cbc1f1
docs: Update span streaming docstrings
sentrivana Sep 11, 2026
210c7da
add link to docs
sentrivana Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions sentry_sdk/traces.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
"""
EXPERIMENTAL. Do not use in production.
The API in this file is only meant to be used in span streaming mode. It should
not be mixed with the legacy tracing API (sentry_sdk.start_transaction,
sentry_sdk.start_span, etc.).

The API in this file is only meant to be used in span streaming mode.
You can enable span streaming mode via:

You can enable span streaming mode via
sentry_sdk.init(trace_lifecycle="stream").
```
import sentry_sdk

sentry_sdk.init(
trace_lifecycle="stream",
)
```

See
https://docs.sentry.io/platforms/python/tracing/streamed-spans/migration-guide/
for how to migrate to span streaming.
"""

import sys
Expand Down Expand Up @@ -110,10 +121,7 @@ def start_span(
active: bool = True,
) -> "StreamedSpan":
"""
Start a span.

EXPERIMENTAL. Use sentry_sdk.start_transaction() and sentry_sdk.start_span()
instead.
Start a span in streaming mode.

The span's parent, unless provided explicitly via the `parent_span` argument,
will be the current active span, if any. If there is none, this span will
Expand Down Expand Up @@ -185,9 +193,7 @@ def start_span(

def continue_trace(incoming: "dict[str, Any]") -> None:
"""
Continue a trace from headers or environment variables.

EXPERIMENTAL. Use sentry_sdk.continue_trace() instead.
Continue a trace from headers or environment variables in streaming mode.

This function sets the propagation context on the scope. Any span started
in the updated scope will belong under the trace extracted from the
Expand All @@ -211,9 +217,7 @@ def continue_trace(incoming: "dict[str, Any]") -> None:

def new_trace() -> None:
"""
Resets the propagation context, forcing a new trace.

EXPERIMENTAL.
Resets the propagation context, forcing a new trace, in streaming mode.

This function sets the propagation context on the scope. Any span started
in the updated scope will start its own trace.
Expand Down Expand Up @@ -811,9 +815,7 @@ def trace(
active: bool = True,
) -> "Union[Callable[P, R], Callable[[Callable[P, R]], Callable[P, R]]]":
"""
Decorator to start a span around a function call.

EXPERIMENTAL. Use @sentry_sdk.trace instead.
Decorator to start a span around a function call in streaming mode.

This decorator automatically creates a new span when the decorated function
is called, and finishes the span when the function returns or raises an exception.
Expand Down
Loading