Finish long running transactions at some point.

Author: antonpirker

sentry_sdk/integrations/wsgi.py

@@ -1,3 +1,4 @@
+from datetime import datetime, timezone
 import sys
 from functools import partial
 
@@ -45,6 +46,9 @@ def __call__(self, status, response_headers, exc_info=None):  # type: ignore
             pass
 
 
+MAX_TRANSACTION_DURATION_MINUTES = 5
+
+
 _wsgi_middleware_applied = ContextVar("sentry_wsgi_middleware_applied")
 
 
@@ -272,6 +276,17 @@ def __iter__(self):
 
                 yield chunk
 
+                # Finish long running transactions at some point
+                try:
+                    transaction_duration = (datetime.now(timezone.utc) - self._current_scope.transaction.start_timestamp).total_seconds() / 60
+                    if transaction_duration > MAX_TRANSACTION_DURATION_MINUTES:
+                        with use_isolation_scope(self._isolation_scope):
+                            with use_scope(self._current_scope):
+                                finish_running_transaction(self._current_scope)
+                except AttributeError:
+                    # transaction is not there anymore
+                    pass
+
         finally:
             with use_isolation_scope(self._isolation_scope):
                 with use_scope(self._current_scope):

tests/integrations/wsgi/test_wsgi.py

@@ -1,7 +1,9 @@
+import time
 from collections import Counter
 from unittest import mock
 
 import pytest
+from sentry_sdk.utils import datetime_from_isoformat
 from werkzeug.test import Client
 
 import sentry_sdk
@@ -495,3 +497,33 @@ def dogpark(environ, start_response):
     (event,) = events
 
     assert event["contexts"]["trace"]["origin"] == "auto.dogpark.deluxe"
+
+
+def test_long_running_transaction_finished(sentry_init, capture_events):
+    # we allow transactions to be 0.5 seconds as a maximum
+    new_max_duration = 0.5 / 60
+
+    with mock.patch.object(sentry_sdk.integrations.wsgi, "MAX_TRANSACTION_DURATION_MINUTES", new_max_duration):
+        def generate_content():
+            # This response will take 1.5 seconds to generate
+            for _ in range(15):
+                time.sleep(0.1)
+                yield "ok"
+
+        def long_running_app(environ, start_response):
+            start_response("200 OK", [])
+            return generate_content()
+
+        sentry_init(send_default_pii=True, traces_sample_rate=1.0)
+        app = SentryWsgiMiddleware(long_running_app)
+
+        events = capture_events()
+
+        client = Client(app)
+        response = client.get("/")
+        _ = response.get_data()
+
+        (transaction,) = events
+
+        transaction_duration = (datetime_from_isoformat(transaction["timestamp"]) - datetime_from_isoformat(transaction["start_timestamp"])).total_seconds() / 60
+        assert transaction_duration <= new_max_duration * 1.05  # we allow 2% error margin for processing the request