Skip to content

feat(pymongo): Add span streaming support #6253

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
ericapisani merged 5 commits into from
May 12, 2026
+281 −53
Merged

feat(pymongo): Add span streaming support #6253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b8ddc07
feat(pymongo): Add span streaming support
ericapisani May 11, 2026
67383b2
Address bugbot comment
ericapisani May 11, 2026
eb4a7bd
Fix error
ericapisani May 11, 2026
04bf803
Address PR comments
ericapisani May 12, 2026
30ba6da
address bot comments
ericapisani May 12, 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
148 changes: 99 additions & 49 deletions sentry_sdk/integrations/pymongo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
import json

import sentry_sdk
from sentry_sdk.consts import SPANSTATUS, SPANDATA, OP
from sentry_sdk.consts import OP, SPANDATA, SPANSTATUS
from sentry_sdk.integrations import DidNotEnable, Integration
from sentry_sdk.scope import should_send_default_pii
from sentry_sdk.traces import SpanStatus, StreamedSpan
from sentry_sdk.tracing import Span
from sentry_sdk.tracing_utils import has_span_streaming_enabled
from sentry_sdk.utils import capture_internal_exceptions

try:
Expand Down Expand Up @@ -87,12 +89,11 @@ def _strip_pii(command: "Dict[str, Any]") -> "Dict[str, Any]":
def _get_db_data(event: "Any") -> "Dict[str, Any]":
data = {}

data[SPANDATA.DB_SYSTEM] = "mongodb"
data[SPANDATA.DB_DRIVER_NAME] = "pymongo"
client = sentry_sdk.get_client()
is_span_streaming_enabled = has_span_streaming_enabled(client.options)

data[SPANDATA.DB_DRIVER_NAME] = "pymongo"
db_name = event.database_name
if db_name is not None:
data[SPANDATA.DB_NAME] = db_name

server_address = event.connection_id[0]
Copy link
Copy Markdown

@sentry sentry Bot May 12, 2026

Choose a reason for hiding this comment

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

Bug: Accessing a non-indexable event.connection_id in _get_db_data raises a TypeError that is silently caught, causing the entire pymongo span to be dropped.
Severity: MEDIUM

Suggested Fix

Wrap the access to event.connection_id within a try...except TypeError block. This will prevent the unhandled exception from halting execution, allowing the span to be created even if peer address data cannot be extracted.

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: sentry_sdk/integrations/pymongo.py#L98

Potential issue: The function `_get_db_data` directly accesses `event.connection_id` to
retrieve database connection details. If `event.connection_id` is not an indexable type
(e.g., an integer), a `TypeError` is raised. This exception is caught and suppressed by
the `capture_internal_exceptions` context manager, which then prematurely exits the
`with` block. As a consequence, the associated Sentry span is never created, and the
entire pymongo event is silently dropped. This is a regression from previous behavior
where this error was handled, and a span was still created.

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

if server_address is not None:
Expand All @@ -102,12 +103,23 @@ def _get_db_data(event: "Any") -> "Dict[str, Any]":
if server_port is not None:
data[SPANDATA.SERVER_PORT] = server_port

if is_span_streaming_enabled:
data["db.system.name"] = "mongodb"

if db_name is not None:
data["db.namespace"] = db_name
Comment thread
ericapisani marked this conversation as resolved.
else:
data[SPANDATA.DB_SYSTEM] = "mongodb"

if db_name is not None:
data[SPANDATA.DB_NAME] = db_name

return data


class CommandTracer(monitoring.CommandListener):
def __init__(self) -> None:
self._ongoing_operations: "Dict[int, Span]" = {}
self._ongoing_operations: "Dict[int, Union[Span, StreamedSpan]]" = {}

def _operation_key(
self,
Expand All @@ -116,7 +128,8 @@ def _operation_key(
return event.request_id

def started(self, event: "CommandStartedEvent") -> None:
if sentry_sdk.get_client().get_integration(PyMongoIntegration) is None:
client = sentry_sdk.get_client()
if client.get_integration(PyMongoIntegration) is None:
return

with capture_internal_exceptions():
Expand All @@ -126,56 +139,88 @@ def started(self, event: "CommandStartedEvent") -> None:
command.pop("$clusterTime", None)
command.pop("$signature", None)

tags = {
"db.name": event.database_name,
SPANDATA.DB_SYSTEM: "mongodb",
SPANDATA.DB_DRIVER_NAME: "pymongo",
SPANDATA.DB_OPERATION: event.command_name,
SPANDATA.DB_MONGODB_COLLECTION: command.get(event.command_name),
}

try:
Comment thread
ericapisani marked this conversation as resolved.
tags["net.peer.name"] = event.connection_id[0]
tags["net.peer.port"] = str(event.connection_id[1])
except TypeError:
pass
db_data = _get_db_data(event)

data: "Dict[str, Any]" = {"operation_ids": {}}
data["operation_ids"]["operation"] = event.operation_id
data["operation_ids"]["request"] = event.request_id

data.update(_get_db_data(event))

try:
lsid = command.pop("lsid")["id"]
data["operation_ids"]["session"] = str(lsid)
except KeyError:
pass
collection_name = command.get(event.command_name)
operation_name = event.command_name
db_name = event.database_name

lsid = command.pop("lsid", None)
if not should_send_default_pii():
command = _strip_pii(command)

query = json.dumps(command, default=str)
span = sentry_sdk.start_span(
op=OP.DB,
name=query,
origin=PyMongoIntegration.origin,
)

for tag, value in tags.items():
# set the tag for backwards-compatibility.
# TODO: remove the set_tag call in the next major release!
span.set_tag(tag, value)
if has_span_streaming_enabled(client.options):
span_first_data = {
"db.operation.name": operation_name,
"db.collection.name": collection_name,
"sentry.op": OP.DB,
"sentry.origin": PyMongoIntegration.origin,
**db_data,
}
Comment thread
cursor[bot] marked this conversation as resolved.

span = sentry_sdk.traces.start_span(
name=query, attributes=span_first_data
)

with capture_internal_exceptions():
sentry_sdk.add_breadcrumb(
message=query,
category="query",
type=OP.DB,
data=span_first_data,
)

else:
tags = {
"db.name": db_name,
SPANDATA.DB_SYSTEM: "mongodb",
SPANDATA.DB_DRIVER_NAME: "pymongo",
SPANDATA.DB_OPERATION: operation_name,
# The below is a deprecated field, but leaving for legacy reasons.
# The v2 spans will use `db.collection.name` instead.
SPANDATA.DB_MONGODB_COLLECTION: collection_name,
}

try:
tags["net.peer.name"] = event.connection_id[0]
tags["net.peer.port"] = str(event.connection_id[1])
except TypeError:
pass

data: "Dict[str, Any]" = {"operation_ids": {}}
data["operation_ids"]["operation"] = event.operation_id
data["operation_ids"]["request"] = event.request_id
Copy link
Copy Markdown
Member Author

@ericapisani ericapisani May 11, 2026

Choose a reason for hiding this comment

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

These are also kept for legacy reasons, are being removed for streamed spans.


data.update(db_data)

try:
if lsid:
lsid_id = lsid["id"]
data["operation_ids"]["session"] = str(lsid_id)
except KeyError:
pass

span = sentry_sdk.start_span(
op=OP.DB,
name=query,
origin=PyMongoIntegration.origin,
)

span.set_data(tag, value)
for tag, value in tags.items():
# set the tag for backwards-compatibility.
# TODO: remove the set_tag call in the next major release!
span.set_tag(tag, value)
span.set_data(tag, value)

for key, value in data.items():
span.set_data(key, value)
for key, value in data.items():
span.set_data(key, value)

with capture_internal_exceptions():
sentry_sdk.add_breadcrumb(
message=query, category="query", type=OP.DB, data=tags
)
with capture_internal_exceptions():
sentry_sdk.add_breadcrumb(
message=query, category="query", type=OP.DB, data=tags
)

self._ongoing_operations[self._operation_key(event)] = span.__enter__()

Expand All @@ -185,7 +230,11 @@ def failed(self, event: "CommandFailedEvent") -> None:

try:
span = self._ongoing_operations.pop(self._operation_key(event))
span.set_status(SPANSTATUS.INTERNAL_ERROR)
# Ignoring NoOpStreamedSpan as it will always have a status of "ok"
if type(span) is StreamedSpan:
span.status = SpanStatus.ERROR
elif type(span) is Span:
span.set_status(SPANSTATUS.INTERNAL_ERROR)
span.__exit__(None, None, None)
except KeyError:
return
Expand All @@ -196,7 +245,8 @@ def succeeded(self, event: "CommandSucceededEvent") -> None:

try:
span = self._ongoing_operations.pop(self._operation_key(event))
span.set_status(SPANSTATUS.OK)
if type(span) is Span:
span.set_status(SPANSTATUS.OK)
span.__exit__(None, None, None)
except KeyError:
pass
Expand Down
Loading
Loading