Fix breadcrumb in subprocess

Author: antonpirker

sentry_sdk/integrations/clickhouse_driver.py

@@ -119,8 +119,8 @@ def _inner_end(*args: P.args, **kwargs: P.kwargs) -> T:
 
             with capture_internal_exceptions():
                 span.scope.add_breadcrumb(
-                    message=span._data.pop("query"), 
-                    category="query", 
+                    message=span._data.pop("query"),
+                    category="query",
                     data=span._data,
                 )
 

sentry_sdk/integrations/stdlib.py

@@ -13,6 +13,7 @@
     SENSITIVE_DATA_SUBSTITUTE,
     capture_internal_exceptions,
     ensure_integration_enabled,
+    get_current_thread_meta,
     is_sentry_url,
     logger,
     safe_repr,
@@ -225,6 +226,24 @@ def sentry_patched_popen_init(self, *a, **kw):
             rv = old_popen_init(self, *a, **kw)
 
             span.set_tag("subprocess.pid", self.pid)
+
+            with capture_internal_exceptions():
+                thread_id, thread_name = get_current_thread_meta()
+                breadcrumb_data = {
+                    "subprocess.pid": self.pid,
+                    "thread.id": thread_id,
+                    "thread.name": thread_name,
+                }
+                if cwd:
+                    breadcrumb_data["subprocess.cwd"] = cwd
+
+                sentry_sdk.add_breadcrumb(
+                    type="subprocess",
+                    category="subprocess",
+                    message=description,
+                    data=breadcrumb_data,
+                )
+
             return rv
 
     subprocess.Popen.__init__ = sentry_patched_popen_init  # type: ignore

sentry_sdk/tracing.py

@@ -1586,6 +1586,7 @@ def get_profile_context(self):
     def set_context(self, key, value):
         # type: (str, Any) -> None
         from sentry_sdk.integrations.opentelemetry.consts import SentrySpanAttribute
+
         # TODO-neel-potel we cannot add dicts here
 
         self.set_attribute(f"{SentrySpanAttribute.CONTEXT}.{key}", value)

sentry_sdk/tracing_utils.py

@@ -158,22 +158,15 @@ def maybe_create_breadcrumbs_from_span(scope, span):
     # type: (sentry_sdk.Scope, sentry_sdk.tracing.Span) -> None
     if span.op == OP.DB_REDIS:
         scope.add_breadcrumb(
-            message=span.description, 
-            type="redis", 
-            category="redis", 
+            message=span.description,
+            type="redis",
+            category="redis",
             data=span._tags,
         )
     elif span.op == OP.HTTP_CLIENT:
         scope.add_breadcrumb(
-            type="http", 
-            category="httplib", 
-            data=span._data, 
-        )
-    elif span.op == OP.SUBPROCESS:
-        scope.add_breadcrumb(
-            type="subprocess",
-            category="subprocess",
-            message=span.description,
+            type="http",
+            category="httplib",
             data=span._data,
         )
 

tests/integrations/stdlib/test_subprocess.py

@@ -3,10 +3,11 @@
 import subprocess
 import sys
 from collections.abc import Mapping
+from unittest import mock
 
 import pytest
 
-from sentry_sdk import capture_message, start_transaction
+from sentry_sdk import capture_exception, capture_message, start_transaction
 from sentry_sdk.integrations.stdlib import StdlibIntegration
 from tests.conftest import ApproxDict
 
@@ -224,3 +225,37 @@ def test_subprocess_span_origin(sentry_init, capture_events):
 
     assert event["spans"][2]["op"] == "subprocess.wait"
     assert event["spans"][2]["origin"] == "auto.subprocess.stdlib.subprocess"
+
+
+def test_subprocess_breadcrumb(sentry_init, capture_events):
+    sentry_init()
+    events = capture_events()
+
+    args = [
+        sys.executable,
+        "-c",
+        "print('hello world')",
+    ]
+    popen = subprocess.Popen(args)
+    popen.communicate()
+    popen.poll()
+
+    try:
+        1 / 0
+    except ZeroDivisionError as ex:
+        capture_exception(ex)
+
+    (event,) = events
+    breadcrumbs = event["breadcrumbs"]["values"]
+    assert len(breadcrumbs) == 1
+
+    (crumb,) = breadcrumbs
+    assert crumb["type"] == "subprocess"
+    assert crumb["category"] == "subprocess"
+    assert crumb["message"] == " ".join(args)
+    assert crumb["timestamp"] == mock.ANY
+    assert crumb["data"] == {
+        "subprocess.pid": popen.pid,
+        "thread.id": mock.ANY,
+        "thread.name": mock.ANY,
+    }

tests/test_breadcrumbs.py

@@ -33,7 +33,9 @@ def test_breadcrumbs(sentry_init, capture_envelopes):
             sentry_sdk.add_breadcrumb(message="breadcrumb1", **add_breadcrumbs_kwargs)
 
             with sentry_sdk.start_span(name="span2", op="function"):
-                sentry_sdk.add_breadcrumb(message="breadcrumb2", **add_breadcrumbs_kwargs)
+                sentry_sdk.add_breadcrumb(
+                    message="breadcrumb2", **add_breadcrumbs_kwargs
+                )
 
                 # Spans that create breadcrumbs automatically
                 with sentry_sdk.start_span(name="span3", op=OP.DB_REDIS) as span3:
@@ -49,14 +51,16 @@ def test_breadcrumbs(sentry_init, capture_envelopes):
                     span5.set_tag("span5_tag", "tag on the subprocess span")
 
                 with sentry_sdk.start_span(name="span6", op="function") as span6:
-                    # This data on the span is not added to custom breadcrumbs. 
+                    # This data on the span is not added to custom breadcrumbs.
                     # Data from the span is only added to automatic breadcrumbs shown above
                     span6.set_data("span6_data", "data on span6")
                     span6.set_tag("span6_tag", "tag on the span6")
-                    sentry_sdk.add_breadcrumb(message="breadcrumb6", **add_breadcrumbs_kwargs)
+                    sentry_sdk.add_breadcrumb(
+                        message="breadcrumb6", **add_breadcrumbs_kwargs
+                    )
 
                     try:
-                        1/0 
+                        1 / 0
                     except ZeroDivisionError as ex:
                         sentry_sdk.capture_exception(ex)
 
@@ -96,7 +100,7 @@ def test_breadcrumbs(sentry_init, capture_envelopes):
         "span3_tag": "tag on the redis span",
     }
     assert breadcrumbs[3]["timestamp"] == mock.ANY
-    
+
     # Check automatic http.client breadcrumbs
     assert "message" not in breadcrumbs[4]
     assert breadcrumbs[4]["type"] == "http"