Link Sentry all the way

Author: alexiri

astra_app/core/context_processors.py

@@ -1,5 +1,6 @@
 from email.utils import parseaddr
 
+import sentry_sdk
 from django.conf import settings
 from django.contrib.staticfiles.storage import staticfiles_storage
 from django.urls import reverse
@@ -47,6 +48,8 @@ def chat_networks(_request) -> dict[str, object]:
 def build_info(_request) -> dict[str, object]:
     sentry_browser_bundle_src = ""
     sentry_browser_config: dict[str, object] | None = None
+    sentry_trace = ""
+    sentry_baggage = ""
     if settings.SENTRY_DSN:
         sentry_browser_bundle_src = staticfiles_storage.url("core/vendor/sentry/bundle.tracing.min.js")
         sentry_browser_config = {
@@ -56,12 +59,16 @@ def build_info(_request) -> dict[str, object]:
             "tracesSampleRate": settings.SENTRY_TRACES_SAMPLE_RATE,
             "tunnel": reverse("sentry-browser-tunnel"),
         }
+        sentry_trace = sentry_sdk.get_traceparent() or ""
+        sentry_baggage = sentry_sdk.get_baggage() or ""
 
     return {
         "build_sha": get_build_sha(),
         "default_from_email_address": parseaddr(settings.DEFAULT_FROM_EMAIL)[1].strip(),
         "sentry_browser_bundle_src": sentry_browser_bundle_src,
         "sentry_browser_config": sentry_browser_config,
+        "sentry_trace": sentry_trace,
+        "sentry_baggage": sentry_baggage,
     }
 
 

astra_app/core/templates/core/base.html

@@ -19,6 +19,8 @@
     <link rel="stylesheet" href="{% static 'core/css/login.css' %}" />
   {% endif %}
   {% if sentry_browser_bundle_src and sentry_browser_config %}
+    {% if sentry_trace %}<meta name="sentry-trace" content="{{ sentry_trace }}">{% endif %}
+    {% if sentry_baggage %}<meta name="baggage" content="{{ sentry_baggage }}">{% endif %}
     {{ sentry_browser_config|json_script:"sentry-browser-config" }}
     <script src="{{ sentry_browser_bundle_src }}"></script>
     <script>

astra_app/core/tests/test_sentry_browser_templates.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from types import SimpleNamespace
 from unittest.mock import patch
 
@@ -20,7 +21,11 @@ def test_vendored_sentry_bundle_sourcemap_exists(self) -> None:
         SENTRY_TRACES_SAMPLE_RATE=0.25,
     )
     def test_build_info_exposes_sentry_browser_bundle_and_config(self) -> None:
-        context = build_info(SimpleNamespace())
+        with patch("core.context_processors.sentry_sdk.get_traceparent", return_value="trace-parent"), patch(
+            "core.context_processors.sentry_sdk.get_baggage",
+            return_value="sentry-sample=value",
+        ):
+            context = build_info(SimpleNamespace())
 
         self.assertEqual(
             context["sentry_browser_bundle_src"],
@@ -36,13 +41,17 @@ def test_build_info_exposes_sentry_browser_bundle_and_config(self) -> None:
                 "tunnel": "/_ci/envelope/",
             },
         )
+        self.assertEqual(context["sentry_trace"], "trace-parent")
+        self.assertEqual(context["sentry_baggage"], "sentry-sample=value")
 
     @override_settings(SENTRY_DSN="")
     def test_build_info_omits_sentry_browser_config_without_dsn(self) -> None:
         context = build_info(SimpleNamespace())
 
         self.assertEqual(context["sentry_browser_bundle_src"], "")
         self.assertIsNone(context["sentry_browser_config"])
+        self.assertEqual(context["sentry_trace"], "")
+        self.assertEqual(context["sentry_baggage"], "")
 
 
 class SentryBrowserTemplateTests(TestCase):
@@ -71,7 +80,13 @@ def test_profile_page_includes_sentry_browser_bundle_and_tunnel_config(self) ->
             },
         )
 
-        with patch("core.freeipa.user.FreeIPAUser.get", return_value=freeipa_user):
+        with patch("core.freeipa.user.FreeIPAUser.get", return_value=freeipa_user), patch(
+            "core.context_processors.sentry_sdk.get_traceparent",
+            return_value="trace-parent",
+        ), patch(
+            "core.context_processors.sentry_sdk.get_baggage",
+            return_value="sentry-sample=value",
+        ):
             response = self.client.get(f"/user/{username}/")
 
         self.assertEqual(response.status_code, 200)
@@ -80,8 +95,19 @@ def test_profile_page_includes_sentry_browser_bundle_and_tunnel_config(self) ->
             'src="/static/core/vendor/sentry/bundle.tracing.min.js"',
         )
         self.assertContains(response, 'id="sentry-browser-config"')
+        self.assertContains(response, '<meta name="sentry-trace" content="trace-parent">', html=True)
+        self.assertContains(response, '<meta name="baggage" content="sentry-sample=value">', html=True)
         self.assertContains(response, "window.Sentry && window.Sentry.init")
         self.assertContains(response, '"environment": "staging"')
         self.assertContains(response, '"release": "build-123"')
         self.assertContains(response, '"tracesSampleRate": 0.25')
-        self.assertContains(response, '"tunnel": "/_ci/envelope/"')
+        self.assertContains(response, '"tunnel": "/_ci/envelope/"')
+
+
+class SentryCaddyConfigTests(SimpleTestCase):
+    def test_caddy_configs_forward_sentry_trace_headers(self) -> None:
+        repo_root = Path(__file__).resolve().parents[3]
+        for relative_path in ("infra/systemd/Caddyfile", "infra/systemd/Caddyfile.j2"):
+            source = (repo_root / relative_path).read_text(encoding="utf-8")
+            self.assertIn("header_up sentry-trace", source)
+            self.assertIn("header_up baggage", source)

infra/systemd/Caddyfile

@@ -10,12 +10,16 @@ accounts.almalinux.org {
         lb_policy least_conn
         lb_retries 2
         header_up X-Forwarded-For {http.request.header.CF-Connecting-IP}
+        header_up sentry-trace {http.request.header.sentry-trace}
+        header_up baggage {http.request.header.baggage}
         health_uri /readyz
     }
 
     reverse_proxy 127.0.0.1:8001 127.0.0.1:8002 {
         lb_policy least_conn
         lb_retries 2
+        header_up sentry-trace {http.request.header.sentry-trace}
+        header_up baggage {http.request.header.baggage}
         health_uri /readyz
     }
 }

infra/systemd/Caddyfile.j2

@@ -20,7 +20,10 @@
     # Clients must trust Caddy's internal CA (or use curl -k).
     tls internal
 
-    reverse_proxy 127.0.0.1:8001 127.0.0.1:8002
+    reverse_proxy 127.0.0.1:8001 127.0.0.1:8002 {
+        header_up sentry-trace {http.request.header.sentry-trace}
+        header_up baggage {http.request.header.baggage}
+    }
 }
 {% else %}
 :80 {
@@ -32,6 +35,9 @@
     # Clients must trust Caddy's internal CA (or use curl -k).
     tls internal
 
-    reverse_proxy 127.0.0.1:8001 127.0.0.1:8002
+    reverse_proxy 127.0.0.1:8001 127.0.0.1:8002 {
+        header_up sentry-trace {http.request.header.sentry-trace}
+        header_up baggage {http.request.header.baggage}
+    }
 }
 {% endif %}