Skip to content

feat(boto3): Support span streaming #6193

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

Open
alexander-alderman-webb wants to merge 18 commits into
base: master
Choose a base branch
from
+395 −137
Open

feat(boto3): Support span streaming #6193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
c24ed84
feat(boto3): Support span streaming
alexander-alderman-webb May 4, 2026
3d0f22f
add type hint
alexander-alderman-webb May 4, 2026
9424125
simplify conditional
alexander-alderman-webb May 4, 2026
4cadf25
add variable declaration
alexander-alderman-webb May 4, 2026
839ad7c
simplify tests
alexander-alderman-webb May 4, 2026
7eea15d
remove double init
alexander-alderman-webb May 4, 2026
f5bdf48
type hint
alexander-alderman-webb May 4, 2026
13739ca
docstring
alexander-alderman-webb May 4, 2026
11b122b
update attributes
alexander-alderman-webb May 5, 2026
3386cc3
add const
alexander-alderman-webb May 5, 2026
a5ef80a
hyphenize service_id
alexander-alderman-webb May 5, 2026
90f8e97
add linting req
alexander-alderman-webb May 5, 2026
c3a55c6
merge master
alexander-alderman-webb May 5, 2026
7e39d58
check None before setting attribute
alexander-alderman-webb May 5, 2026
10c67de
don't gate rpc method
alexander-alderman-webb May 5, 2026
88928ad
fix assertions
alexander-alderman-webb May 5, 2026
8f613f9
stop using deprecated finish()
alexander-alderman-webb May 5, 2026
8121605
update
alexander-alderman-webb May 5, 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
6 changes: 6 additions & 0 deletions sentry_sdk/consts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -893,6 +893,12 @@ class SPANDATA:
Example: "5249fbada8d5416482c2f6e47e337372"
"""

RPC_METHOD = "rpc.method"
"""
The fully-qualified logical name of the method from the RPC interface perspective.
Example: "com.example.ExampleService/exampleMethod"
"""

SERVER_ADDRESS = "server.address"
"""
Name of the database host.
Expand Down
108 changes: 79 additions & 29 deletions sentry_sdk/integrations/boto3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
from sentry_sdk.consts import OP, SPANDATA
from sentry_sdk.integrations import _check_minimum_version, Integration, DidNotEnable
from sentry_sdk.tracing import Span
from sentry_sdk.traces import StreamedSpan
from sentry_sdk.tracing_utils import has_span_streaming_enabled
from sentry_sdk.utils import (
capture_internal_exceptions,
ensure_integration_enabled,
Expand All @@ -18,6 +20,9 @@
from typing import Dict
from typing import Optional
from typing import Type
from typing import Union

from botocore.model import ServiceId

try:
from botocore import __version__ as BOTOCORE_VERSION
Expand All @@ -44,7 +49,7 @@ def sentry_patched_init(
) -> None:
orig_init(self, *args, **kwargs)
meta = self.meta
service_id = meta.service_model.service_id.hyphenize()
service_id = meta.service_model.service_id
meta.events.register(
"request-created",
partial(_sentry_request_created, service_id=service_id),
Expand All @@ -57,25 +62,48 @@ def sentry_patched_init(

@ensure_integration_enabled(Boto3Integration)
def _sentry_request_created(
service_id: str, request: "AWSRequest", operation_name: str, **kwargs: "Any"
service_id: "ServiceId", request: "AWSRequest", operation_name: str, **kwargs: "Any"
) -> None:
description = "aws.%s.%s" % (service_id, operation_name)
span = sentry_sdk.start_span(
op=OP.HTTP_CLIENT,
name=description,
origin=Boto3Integration.origin,
)

if request.url is not None:
with capture_internal_exceptions():
parsed_url = parse_url(request.url, sanitize=False)
span.set_data("aws.request.url", parsed_url.url)
span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

span.set_tag("aws.service_id", service_id)
span.set_tag("aws.operation_name", operation_name)
span.set_data(SPANDATA.HTTP_METHOD, request.method)
description = "aws.%s.%s" % (service_id.hyphenize(), operation_name)

client = sentry_sdk.get_client()
span_streaming = has_span_streaming_enabled(client.options)
Copy link
Copy Markdown
Member

@ericapisani ericapisani May 5, 2026

Choose a reason for hiding this comment

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

For variable names capturing states (like this one), naming it like a noun/a thing makes it harder to read in isolation in other areas of the code.

Something that leverages a verb/predicate, along the lines of is_span_streaming_enabled, is generally better for values/variables like this.

span: "Union[Span, StreamedSpan]"
if span_streaming:
span = sentry_sdk.traces.start_span(
name=description,
attributes={
"sentry.op": OP.HTTP_CLIENT,
"sentry.origin": Boto3Integration.origin,
},
)
if request.url is not None:
with capture_internal_exceptions():
parsed_url = parse_url(request.url, sanitize=False)
span.set_attribute(SPANDATA.URL_FULL, parsed_url.url)
span.set_attribute(SPANDATA.URL_QUERY, parsed_url.query)
span.set_attribute(SPANDATA.URL_FRAGMENT, parsed_url.fragment)

span.set_attribute(SPANDATA.RPC_METHOD, f"{service_id}/{operation_name}")
Copy link
Copy Markdown
Member

@ericapisani ericapisani May 5, 2026

Choose a reason for hiding this comment

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

Because this is set outside of any conditionals within this block, you could move this up into the attributes dict passed in start_span above

if request.method is not None:
Copy link
Copy Markdown
Member

@ericapisani ericapisani May 5, 2026

Choose a reason for hiding this comment

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

I noticed that the legacy approach doesn't have this guard, and I assume it's because set_data is typed more permissively in that it accepts None where set_attribute does not.

This makes me wonder - are we currently sending None values within the envelope for legacy spans for the HTTP_METHOD on line 106? I wonder if we should also guard that in order to remove an unnecessary value being added 🤔

span.set_attribute(SPANDATA.HTTP_REQUEST_METHOD, request.method)
else:
span = sentry_sdk.start_span(
op=OP.HTTP_CLIENT,
name=description,
origin=Boto3Integration.origin,
)

if request.url is not None:
with capture_internal_exceptions():
parsed_url = parse_url(request.url, sanitize=False)
span.set_data("aws.request.url", parsed_url.url)
span.set_data(SPANDATA.HTTP_QUERY, parsed_url.query)
span.set_data(SPANDATA.HTTP_FRAGMENT, parsed_url.fragment)

span.set_tag("aws.service_id", service_id.hyphenize())
span.set_tag("aws.operation_name", operation_name)
span.set_data(SPANDATA.HTTP_METHOD, request.method)

# We do it in order for subsequent http calls/retries be
# attached to this span.
Expand All @@ -89,7 +117,7 @@ def _sentry_request_created(
def _sentry_after_call(
context: "Dict[str, Any]", parsed: "Dict[str, Any]", **kwargs: "Any"
) -> None:
span: "Optional[Span]" = context.pop("_sentrysdk_span", None)
span: "Optional[Union[Span, StreamedSpan]]" = context.pop("_sentrysdk_span", None)
Comment thread
sentry-warden[bot] marked this conversation as resolved.

# Span could be absent if the integration is disabled.
if span is None:
Expand All @@ -100,29 +128,51 @@ def _sentry_after_call(
if not isinstance(body, StreamingBody):
return

streaming_span = span.start_child(
op=OP.HTTP_CLIENT_STREAM,
name=span.description,
origin=Boto3Integration.origin,
)
streaming_span: "Union[Span, StreamedSpan]"
if isinstance(span, StreamedSpan):
Copy link
Copy Markdown
Member

@ericapisani ericapisani May 5, 2026

Choose a reason for hiding this comment

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

As this is currently written, NoOpStreamedSpan spans will evaluate to true and enter this block. It doesn't look like it'll cause the application to crash as it does have a name property (although it's an empty string), but wanted to call this out in case this is unintentional.

If you only care about StreamedSpans entering this block, then this will need to be updated to type(span) is StreamedSpan.

streaming_span = sentry_sdk.traces.start_span(
name=span.name,
Comment thread
alexander-alderman-webb marked this conversation as resolved.
parent_span=span,
attributes={
"sentry.op": OP.HTTP_CLIENT_STREAM,
"sentry.origin": Boto3Integration.origin,
},
)
else:
streaming_span = span.start_child(
Comment thread
alexander-alderman-webb marked this conversation as resolved.
op=OP.HTTP_CLIENT_STREAM,
name=span.description,
origin=Boto3Integration.origin,
)
Comment thread
alexander-alderman-webb marked this conversation as resolved.

orig_read = body.read
orig_close = body.close

def sentry_streaming_body_read(*args: "Any", **kwargs: "Any") -> bytes:
try:
ret = orig_read(*args, **kwargs)
if not ret:
if ret:
return ret

if isinstance(streaming_span, StreamedSpan):
streaming_span.end()
else:
streaming_span.finish()
return ret
except Exception:
streaming_span.finish()
if isinstance(streaming_span, StreamedSpan):
streaming_span.end()
else:
streaming_span.finish()
raise

body.read = sentry_streaming_body_read # type: ignore

def sentry_streaming_body_close(*args: "Any", **kwargs: "Any") -> None:
streaming_span.finish()
if isinstance(streaming_span, StreamedSpan):
streaming_span.end()
else:
streaming_span.finish()
orig_close(*args, **kwargs)

body.close = sentry_streaming_body_close # type: ignore
Expand All @@ -131,7 +181,7 @@ def sentry_streaming_body_close(*args: "Any", **kwargs: "Any") -> None:
def _sentry_after_call_error(
context: "Dict[str, Any]", exception: "Type[BaseException]", **kwargs: "Any"
) -> None:
span: "Optional[Span]" = context.pop("_sentrysdk_span", None)
span: "Optional[Union[Span, StreamedSpan]]" = context.pop("_sentrysdk_span", None)

# Span could be absent if the integration is disabled.
if span is None:
Expand Down
Loading
Loading