feat: Add concurrent.futures integration

Author: alexander-alderman-webb

sentry_sdk/integrations/concurrent.py

@@ -0,0 +1,46 @@
+from functools import wraps
+
+from concurrent.futures import ThreadPoolExecutor
+
+import sentry_sdk
+from sentry_sdk.integrations import Integration
+from sentry_sdk.scope import use_isolation_scope, use_scope
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Any
+    from typing import Callable
+
+
+class ConcurrentIntegration(Integration):
+    identifier = "concurrent"
+
+    def __init__(self, record_exceptions_on_futures=True):
+        # type: (bool) -> None
+        self.record_exceptions_on_futures = record_exceptions_on_futures
+
+    @staticmethod
+    def setup_once():
+        # type: () -> None
+        old_submit = ThreadPoolExecutor.submit
+
+        @wraps(old_submit)
+        def sentry_submit(self, fn, *args, **kwargs):
+            # type: (ThreadPoolExecutor, Callable, *Any, **Any) -> Any
+            integration = sentry_sdk.get_client().get_integration(ConcurrentIntegration)
+            if integration is None:
+                return old_submit(self, fn, *args, **kwargs)
+
+            isolation_scope = sentry_sdk.get_isolation_scope().fork()
+            current_scope = sentry_sdk.get_current_scope().fork()
+
+            def wrapped_fn(*args, **kwargs):
+                # type: (*Any, **Any) -> Any
+                with use_isolation_scope(isolation_scope):
+                    with use_scope(current_scope):
+                        return fn(*args, **kwargs)
+
+            return old_submit(self, wrapped_fn, *args, **kwargs)
+
+        ThreadPoolExecutor.submit = sentry_submit

tests/integrations/concurrent/test_concurrent.py

@@ -0,0 +1,133 @@
+from textwrap import dedent
+from concurrent import futures
+from concurrent.futures import Future, ThreadPoolExecutor
+
+import sentry_sdk
+
+from sentry_sdk.integrations.concurrent import ConcurrentIntegration
+
+original_submit = ThreadPoolExecutor.submit
+original_set_exception = Future.set_exception
+
+
+def test_propagates_threadpool_scope(sentry_init, capture_events):
+    sentry_init(
+        default_integrations=False,
+        traces_sample_rate=1.0,
+        integrations=[ConcurrentIntegration()],
+    )
+    events = capture_events()
+
+    def double(number):
+        with sentry_sdk.start_span(op="task", name=str(number)):
+            return number * 2
+
+    with sentry_sdk.start_transaction(name="test_handles_threadpool"):
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
+            tasks = [executor.submit(double, number) for number in [1, 2, 3, 4]]
+            for future in futures.as_completed(tasks):
+                print("Getting future value!", future.result())
+
+    sentry_sdk.flush()
+
+    assert len(events) == 1
+    (event,) = events
+    assert event["spans"][0]["trace_id"] == event["spans"][1]["trace_id"]
+    assert event["spans"][1]["trace_id"] == event["spans"][2]["trace_id"]
+    assert event["spans"][2]["trace_id"] == event["spans"][3]["trace_id"]
+    assert event["spans"][3]["trace_id"] == event["spans"][0]["trace_id"]
+
+
+def test_propagates_threadpool_scope_in_map(sentry_init, capture_events):
+    sentry_init(
+        default_integrations=False,
+        traces_sample_rate=1.0,
+        integrations=[ConcurrentIntegration()],
+    )
+    events = capture_events()
+
+    def double(number):
+        with sentry_sdk.start_span(op="task", name=str(number)):
+            return number * 2
+
+    with sentry_sdk.start_transaction(name="test_handles_threadpool"):
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
+            for value in executor.map(double, [1, 2, 3, 4]):
+                print("Getting future value!", value)
+
+    sentry_sdk.flush()
+
+    assert len(events) == 1
+    (event,) = events
+    assert event["spans"][0]["trace_id"] == event["spans"][1]["trace_id"]
+    assert event["spans"][1]["trace_id"] == event["spans"][2]["trace_id"]
+    assert event["spans"][2]["trace_id"] == event["spans"][3]["trace_id"]
+    assert event["spans"][3]["trace_id"] == event["spans"][0]["trace_id"]
+
+
+def test_scope_data_not_leaked_in_executor(sentry_init):
+    sentry_init(
+        integrations=[ConcurrentIntegration()],
+    )
+
+    sentry_sdk.set_tag("initial_tag", "initial_value")
+    initial_iso_scope = sentry_sdk.get_isolation_scope()
+
+    def do_some_work():
+        # check if we have the initial scope data propagated into the thread
+        assert sentry_sdk.get_isolation_scope()._tags == {
+            "initial_tag": "initial_value"
+        }
+
+        # change data in isolation scope in thread
+        sentry_sdk.set_tag("thread_tag", "thread_value")
+
+    with futures.ThreadPoolExecutor(max_workers=1) as executor:
+        future = executor.submit(do_some_work)
+        future.result()
+
+    # check if the initial scope data is not modified by the started thread
+    assert initial_iso_scope._tags == {
+        "initial_tag": "initial_value"
+    }, "The isolation scope in the main thread should not be modified by the started thread."
+
+
+def test_spans_from_multiple_threads(sentry_init, capture_events, render_span_tree):
+    sentry_init(
+        traces_sample_rate=1.0,
+        integrations=[ConcurrentIntegration()],
+    )
+    events = capture_events()
+
+    def do_some_work(number):
+        with sentry_sdk.start_span(
+            op=f"inner-run-{number}", name=f"Thread: child-{number}"
+        ):
+            pass
+
+    with sentry_sdk.start_transaction(op="outer-trx"):
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
+            for number in range(5):
+                with sentry_sdk.start_span(
+                    op=f"outer-submit-{number}", name="Thread: main"
+                ):
+                    future = executor.submit(do_some_work, number)
+                    future.result()
+
+    (event,) = events
+
+    assert render_span_tree(event) == dedent(
+        """\
+            - op="outer-trx": description=null
+              - op="outer-submit-0": description="Thread: main"
+                - op="inner-run-0": description="Thread: child-0"
+              - op="outer-submit-1": description="Thread: main"
+                - op="inner-run-1": description="Thread: child-1"
+              - op="outer-submit-2": description="Thread: main"
+                - op="inner-run-2": description="Thread: child-2"
+              - op="outer-submit-3": description="Thread: main"
+                - op="inner-run-3": description="Thread: child-3"
+              - op="outer-submit-4": description="Thread: main"
+                - op="inner-run-4": description="Thread: child-4"\
+"""
+    )

tests/test_basics.py

@@ -868,6 +868,7 @@ def foo(event, hint):
         (["atexit"], "sentry.python"),
         (["boto3"], "sentry.python"),
         (["celery"], "sentry.python"),
+        (["concurrent"], "sentry.python"),
         (["dedupe"], "sentry.python"),
         (["excepthook"], "sentry.python"),
         (["unraisablehook"], "sentry.python"),