feat(bottle): Add span streaming support to Bottle integration (#6486)

Add span streaming support to Bottle integration.

Fixes PY-2310
Fixes #6008

Author: ericapisani

sentry_sdk/integrations/bottle.py

@@ -10,7 +10,9 @@
 )
 from sentry_sdk.integrations._wsgi_common import RequestExtractor
 from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware
-from sentry_sdk.tracing import SOURCE_FOR_STYLE
+from sentry_sdk.traces import SOURCE_FOR_STYLE as SEGMENT_SOURCE_FOR_STYLE
+from sentry_sdk.tracing import SOURCE_FOR_STYLE as TRANSACTION_SOURCE_FOR_STYLE
+from sentry_sdk.tracing_utils import has_span_streaming_enabled
 from sentry_sdk.utils import (
     capture_internal_exceptions,
     ensure_integration_enabled,
@@ -102,6 +104,11 @@ def _patched_handle(self: "Bottle", environ: "Dict[str, Any]") -> "Any":
             )
             res = old_handle(self, environ)
 
+            if has_span_streaming_enabled(sentry_sdk.get_client().options):
+                _set_segment_name_and_source(
+                    transaction_style=integration.transaction_style
+                )
+
             return res
 
         Bottle._handle = _patched_handle
@@ -163,6 +170,25 @@ def size_of_file(self, file: "FileUpload") -> int:
         return file.content_length
 
 
+def _set_segment_name_and_source(transaction_style: str) -> None:
+    try:
+        if transaction_style == "url":
+            name = bottle_request.route.rule or "bottle request"
+        else:
+            name = (
+                bottle_request.route.name
+                or transaction_from_function(bottle_request.route.callback)
+                or "bottle request"
+            )
+
+        sentry_sdk.get_current_scope().set_transaction_name(
+            name,
+            source=SEGMENT_SOURCE_FOR_STYLE[transaction_style],
+        )
+    except RuntimeError:
+        pass
+
+
 def _set_transaction_name_and_source(
     event: "Event", transaction_style: str, request: "Any"
 ) -> None:
@@ -185,7 +211,9 @@ def _set_transaction_name_and_source(
             pass
 
     event["transaction"] = name
-    event["transaction_info"] = {"source": SOURCE_FOR_STYLE[transaction_style]}
+    event["transaction_info"] = {
+        "source": TRANSACTION_SOURCE_FOR_STYLE[transaction_style]
+    }
 
 
 def _make_request_event_processor(

tests/integrations/bottle/test_bottle.py

@@ -8,6 +8,7 @@
 from werkzeug.test import Client
 from werkzeug.wrappers import Response
 
+import sentry_sdk
 from sentry_sdk import capture_message
 from sentry_sdk.integrations.bottle import BottleIntegration
 from sentry_sdk.integrations.logging import LoggingIntegration
@@ -462,23 +463,37 @@ def here():
     assert not events
 
 
+@pytest.mark.parametrize("span_streaming", [True, False])
 def test_span_origin(
     sentry_init,
     get_client,
     capture_events,
+    capture_items,
+    span_streaming,
 ):
     sentry_init(
         integrations=[BottleIntegration()],
         traces_sample_rate=1.0,
+        _experiments={"trace_lifecycle": "stream" if span_streaming else "static"},
     )
-    events = capture_events()
+
+    if span_streaming:
+        items = capture_items("span")
+    else:
+        events = capture_events()
 
     client = get_client()
     client.get("/message")
 
-    (_, event) = events
-
-    assert event["contexts"]["trace"]["origin"] == "auto.http.bottle"
+    if span_streaming:
+        sentry_sdk.flush()
+        spans = [item.payload for item in items]
+        segment = spans[-1]
+        assert segment["is_segment"] is True
+        assert segment["attributes"]["sentry.origin"] == "auto.http.bottle"
+    else:
+        (_, event) = events
+        assert event["contexts"]["trace"]["origin"] == "auto.http.bottle"
 
 
 @pytest.mark.parametrize("raise_error", [True, False])
@@ -556,3 +571,239 @@ def handle():
 
     (event,) = events
     assert event["exception"]["values"][0]["type"] == "ZeroDivisionError"
+
+
+def test_span_streaming_basic(sentry_init, capture_items):
+    sentry_init(
+        integrations=[BottleIntegration()],
+        traces_sample_rate=1.0,
+        _experiments={"trace_lifecycle": "stream"},
+    )
+    items = capture_items("span")
+
+    app = Bottle()
+
+    @app.route("/message")
+    def hi():
+        return "ok"
+
+    client = Client(app)
+    client.get("/message")
+
+    sentry_sdk.flush()
+
+    spans = [item.payload for item in items]
+    assert len(spans) == 1
+
+    segment = spans[0]
+
+    # Segment span (root, created by WSGI middleware)
+    assert segment["is_segment"] is True
+    assert "parent_span_id" not in segment
+    assert segment["status"] == "ok"
+    assert segment["attributes"]["sentry.op"] == "http.server"
+    assert segment["attributes"]["sentry.origin"] == "auto.http.bottle"
+    assert segment["attributes"]["http.request.method"] == "GET"
+    assert segment["attributes"]["http.response.status_code"] == 200
+    assert segment["name"].endswith("hi")
+
+
+@pytest.mark.parametrize(
+    "url,transaction_style,expected_name,expected_source",
+    [
+        ("/message", "endpoint", "hi", "component"),
+        ("/message", "url", "/message", "route"),
+        ("/message/123456", "url", "/message/<message_id>", "route"),
+        ("/message-named-route", "endpoint", "hi", "component"),
+    ],
+)
+def test_span_streaming_transaction_style(
+    sentry_init,
+    capture_items,
+    url,
+    transaction_style,
+    expected_name,
+    expected_source,
+):
+    sentry_init(
+        integrations=[BottleIntegration(transaction_style=transaction_style)],
+        traces_sample_rate=1.0,
+        _experiments={"trace_lifecycle": "stream"},
+    )
+    items = capture_items("span")
+
+    app = Bottle()
+
+    @app.route("/message")
+    def hi():
+        return "ok"
+
+    @app.route("/message/<message_id>")
+    def hi_with_id(message_id):
+        return "ok"
+
+    @app.route("/message-named-route", name="hi")
+    def named_hi():
+        return "ok"
+
+    client = Client(app)
+    client.get(url)
+
+    sentry_sdk.flush()
+
+    spans = [item.payload for item in items]
+    assert len(spans) == 1
+
+    segment = spans[0]
+
+    assert segment["is_segment"] is True
+
+    assert segment["name"].endswith(expected_name)
+    assert segment["attributes"]["sentry.span.source"] == expected_source
+
+
+def test_span_streaming_with_error(sentry_init, capture_items):
+    sentry_init(
+        integrations=[BottleIntegration()],
+        traces_sample_rate=1.0,
+        _experiments={"trace_lifecycle": "stream"},
+    )
+    items = capture_items("event", "span")
+
+    app = Bottle()
+
+    @app.route("/error")
+    def error():
+        1 / 0
+
+    client = Client(app)
+    try:
+        client.get("/error")
+    except ZeroDivisionError:
+        pass
+
+    sentry_sdk.flush()
+
+    events = [item.payload for item in items if item.type == "event"]
+    spans = [item.payload for item in items if item.type == "span"]
+    assert len(events) == 1
+    assert len(spans) == 1
+
+    error_event = events[0]
+    segment = spans[0]
+
+    # Confirm the same trace is shared
+    assert segment["trace_id"] == error_event["contexts"]["trace"]["trace_id"]
+
+    # Span hierarchy
+    assert segment["is_segment"] is True
+    assert "parent_span_id" not in segment
+
+    # Error event span_id points to the segment span (where the exception was raised)
+    assert error_event["contexts"]["trace"]["span_id"] == segment["span_id"]
+
+    # Span status
+    assert segment["status"] == "error"
+
+    # Bottle mechanism on the error event
+    assert error_event["exception"]["values"][0]["mechanism"]["type"] == "bottle"
+    assert error_event["exception"]["values"][0]["mechanism"]["handled"] is False
+
+
+@pytest.mark.parametrize(
+    "status_code,expected_span_status",
+    [
+        (200, "ok"),
+        (404, "error"),
+        (500, "error"),
+    ],
+)
+def test_span_streaming_http_error_status(
+    sentry_init,
+    capture_items,
+    status_code,
+    expected_span_status,
+):
+    sentry_init(
+        integrations=[BottleIntegration()],
+        traces_sample_rate=1.0,
+        _experiments={"trace_lifecycle": "stream"},
+    )
+    items = capture_items("span")
+
+    app = Bottle()
+
+    @app.route("/")
+    def handle():
+        return HTTPResponse(status=status_code, body="response")
+
+    client = Client(app)
+    client.get("/")
+
+    sentry_sdk.flush()
+
+    spans = [item.payload for item in items]
+    assert len(spans) == 1
+
+    segment = spans[0]
+
+    assert segment["is_segment"] is True
+
+    assert segment["status"] == expected_span_status
+    assert segment["attributes"]["http.response.status_code"] == status_code
+
+
+@pytest.mark.parametrize("raise_error", [True, False])
+@pytest.mark.parametrize(
+    ("integration_kwargs", "status_code", "should_capture"),
+    (
+        ({}, 500, True),
+        ({}, 400, False),
+        ({"failed_request_status_codes": set()}, 500, False),
+        ({"failed_request_status_codes": {404, *range(500, 600)}}, 404, True),
+        ({"failed_request_status_codes": {404, *range(500, 600)}}, 400, False),
+    ),
+)
+def test_span_streaming_failed_request_status_codes(
+    sentry_init,
+    capture_items,
+    integration_kwargs,
+    status_code,
+    should_capture,
+    raise_error,
+):
+    sentry_init(
+        integrations=[BottleIntegration(**integration_kwargs)],
+        traces_sample_rate=1.0,
+        _experiments={"trace_lifecycle": "stream"},
+    )
+    items = capture_items("event", "span")
+
+    app = Bottle()
+
+    @app.route("/")
+    def handle():
+        response = HTTPResponse(status=status_code)
+        if raise_error:
+            raise response
+        return response
+
+    client = Client(app, Response)
+    client.get("/")
+
+    sentry_sdk.flush()
+
+    events = [item.payload for item in items if item.type == "event"]
+    spans = [item.payload for item in items if item.type == "span"]
+    assert len(spans) == 1
+
+    segment = spans[0]
+
+    assert segment["is_segment"] is True
+
+    if should_capture:
+        assert len(events) == 1
+        assert events[0]["exception"]["values"][0]["type"] == "HTTPResponse"
+        assert events[0]["exception"]["values"][0]["mechanism"]["handled"] is True
+    else:
+        assert len(events) == 0