feat(tracing): add support for W3C traceparent header in SentryPropagator and enhance tests

Author: hangy

sentry_sdk/integrations/opentelemetry/propagator.py

@@ -28,6 +28,7 @@
 from sentry_sdk.tracing import (
     BAGGAGE_HEADER_NAME,
     SENTRY_TRACE_HEADER_NAME,
+    W3C_TRACE_HEADER_NAME,
 )
 from sentry_sdk.tracing_utils import Baggage, extract_sentrytrace_data
 
@@ -103,6 +104,7 @@ def inject(self, carrier, context=None, setter=default_setter):
             return
 
         setter.set(carrier, SENTRY_TRACE_HEADER_NAME, sentry_span.to_traceparent())
+        setter.set(carrier, W3C_TRACE_HEADER_NAME, sentry_span.to_w3c_traceparent())
 
         if sentry_span.containing_transaction:
             baggage = sentry_span.containing_transaction.get_baggage()
@@ -114,4 +116,4 @@ def inject(self, carrier, context=None, setter=default_setter):
     @property
     def fields(self):
         # type: () -> Set[str]
-        return {SENTRY_TRACE_HEADER_NAME, BAGGAGE_HEADER_NAME}
+        return {SENTRY_TRACE_HEADER_NAME, BAGGAGE_HEADER_NAME, W3C_TRACE_HEADER_NAME}

tests/integrations/asgi/test_asgi.py

@@ -367,6 +367,77 @@ async def test_trace_from_headers_if_performance_disabled(
     assert error_event["contexts"]["trace"]["trace_id"] == trace_id
 
 
+@pytest.mark.asyncio
+async def test_trace_from_w3c_headers_if_performance_enabled(
+    sentry_init,
+    asgi3_app_with_error_and_msg,
+    capture_events,
+):
+    sentry_init(traces_sample_rate=1.0)
+    app = SentryAsgiMiddleware(asgi3_app_with_error_and_msg)
+
+    trace_id = "582b43a4192642f0b136d5159a501701"
+    w3c_trace_header = "00-{}-{}-{}".format(trace_id, "6e8f22c393e68f19", "01")
+
+    with pytest.raises(ZeroDivisionError):
+        async with TestClient(app) as client:
+            events = capture_events()
+            await client.get(
+                "/",
+                headers={
+                    "traceparent": w3c_trace_header,
+                },
+            )
+
+    msg_event, error_event, transaction_event = events
+
+    assert msg_event["contexts"]["trace"]
+    assert "trace_id" in msg_event["contexts"]["trace"]
+
+    assert error_event["contexts"]["trace"]
+    assert "trace_id" in error_event["contexts"]["trace"]
+
+    assert transaction_event["contexts"]["trace"]
+    assert "trace_id" in transaction_event["contexts"]["trace"]
+
+    assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
+    assert error_event["contexts"]["trace"]["trace_id"] == trace_id
+    assert transaction_event["contexts"]["trace"]["trace_id"] == trace_id
+
+
+@pytest.mark.asyncio
+async def test_trace_from_w3c_headers_if_performance_disabled(
+    sentry_init,
+    asgi3_app_with_error_and_msg,
+    capture_events,
+):
+    sentry_init()
+    app = SentryAsgiMiddleware(asgi3_app_with_error_and_msg)
+
+    trace_id = "582b43a4192642f0b136d5159a501701"
+    w3c_trace_header = "00-{}-{}-{}".format(trace_id, "6e8f22c393e68f19", "01")
+
+    with pytest.raises(ZeroDivisionError):
+        async with TestClient(app) as client:
+            events = capture_events()
+            await client.get(
+                "/",
+                headers={
+                    "traceparent": w3c_trace_header,
+                },
+            )
+
+    msg_event, error_event = events
+
+    assert msg_event["contexts"]["trace"]
+    assert "trace_id" in msg_event["contexts"]["trace"]
+    assert msg_event["contexts"]["trace"]["trace_id"] == trace_id
+
+    assert error_event["contexts"]["trace"]
+    assert "trace_id" in error_event["contexts"]["trace"]
+    assert error_event["contexts"]["trace"]["trace_id"] == trace_id
+
+
 @pytest.mark.asyncio
 async def test_websocket(sentry_init, asgi3_ws_app, capture_events, request):
     sentry_init(send_default_pii=True)

tests/integrations/opentelemetry/test_propagator.py

@@ -192,7 +192,7 @@ def test_inject_sentry_span_no_baggage():
         full_context = set_span_in_context(span, context)
         SentryPropagator().inject(carrier, full_context, setter)
 
-        setter.set.assert_called_once_with(
+        setter.set.assert_any_call(
             carrier,
             "sentry-trace",
             "1234567890abcdef1234567890abcdef-1234567890abcdef-1",
@@ -237,7 +237,7 @@ def test_inject_w3c_span_no_baggage():
         full_context = set_span_in_context(span, context)
         SentryPropagator().inject(carrier, full_context, setter)
 
-        setter.set.assert_called_once_with(
+        setter.set.assert_any_call(
             carrier,
             "traceparent",
             "00-ec2da13ee483f41e7323f8c78ed8f4e4-4c6d5fcab571acb0-01",
@@ -281,7 +281,7 @@ def test_inject_sentry_span_empty_baggage():
         full_context = set_span_in_context(span, context)
         SentryPropagator().inject(carrier, full_context, setter)
 
-        setter.set.assert_called_once_with(
+        setter.set.assert_any_call(
             carrier,
             "sentry-trace",
             "1234567890abcdef1234567890abcdef-1234567890abcdef-1",

tests/integrations/tornado/test_tornado.py

@@ -416,7 +416,7 @@ def test_error_has_existing_w3c_trace_context_performance_enabled(
     trace_id = "d6a6892c89ff99522ab2041c4cd71a68"
     parent_span_id = "6fac8cb0c8a904d0"
     parent_sampled = "01"
-    w3c_trace_header = "{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
+    w3c_trace_header = "00-{}-{}-{}".format(trace_id, parent_span_id, parent_sampled)
 
     headers = {"traceparent": w3c_trace_header}