feat(sentry): update sentry configuration

Refs: PT-1958

Author: mhieta

.env.example

@@ -49,3 +49,8 @@ CORS_ALLOW_ALL_ORIGINS=True
 TOKEN_AUTH_BROWSER_TEST_ENABLED=1
 TOKEN_AUTH_BROWSER_TEST_JWT_256BIT_SIGN_SECRET=your-256-bit-secret
 TOKEN_AUTH_BROWSER_TEST_JWT_ISSUER=https://kultus-ui.test.hel.ninja,https://kultus-admin-ui.test.hel.ninja
+
+# SENTRY_DSN=https://abcdefg@your.sentry.here/999
+# SENTRY_PROFILE_SESSION_SAMPLE_RATE=0
+# SENTRY_TRACES_SAMPLE_RATE=0
+# SENTRY_TRACES_IGNORE_PATHS=/healthz,/readiness

palvelutarjotin/settings.py

@@ -5,11 +5,13 @@
 
 import environ
 import sentry_sdk
+from corsheaders.defaults import default_headers
 from csp.constants import SELF as CSP_SELF
 from csp.constants import UNSAFE_INLINE as CSP_UNSAFE_INLINE
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.translation import gettext_lazy as _
 from sentry_sdk.integrations.django import DjangoIntegration
+from sentry_sdk.types import SamplingContext
 
 from palvelutarjotin import __version__
 
@@ -47,7 +49,11 @@
     MAIL_MAILGUN_DOMAIN=(str, ""),
     MAIL_MAILGUN_API=(str, ""),
     SENTRY_DSN=(str, ""),
-    SENTRY_ENVIRONMENT=(str, ""),
+    SENTRY_ENVIRONMENT=(str, "local"),
+    SENTRY_PROFILE_SESSION_SAMPLE_RATE=(float, None),
+    SENTRY_RELEASE=(str, None),
+    SENTRY_TRACES_SAMPLE_RATE=(float, None),
+    SENTRY_TRACES_IGNORE_PATHS=(list, ["/healthz", "/readiness"]),
     CORS_ALLOWED_ORIGINS=(list, []),
     CORS_ALLOWED_ORIGIN_REGEXES=(list, []),
     CORS_ALLOW_ALL_ORIGINS=(bool, False),
@@ -163,12 +169,35 @@
 
 COMMIT_HASH = env("OPENSHIFT_BUILD_COMMIT")
 VERSION = __version__
-sentry_sdk.init(
-    dsn=env.str("SENTRY_DSN"),
-    release=env.str("OPENSHIFT_BUILD_COMMIT", VERSION),
-    environment=env("SENTRY_ENVIRONMENT"),
-    integrations=[DjangoIntegration()],
-)
+
+SENTRY_TRACES_SAMPLE_RATE = env("SENTRY_TRACES_SAMPLE_RATE")
+SENTRY_TRACES_IGNORE_PATHS = env.list("SENTRY_TRACES_IGNORE_PATHS")
+
+
+def sentry_traces_sampler(sampling_context: SamplingContext) -> float:
+    # Respect parent sampling decision if one exists. Recommended by Sentry.
+    if (parent_sampled := sampling_context.get("parent_sampled")) is not None:
+        return float(parent_sampled)
+
+    # Exclude health check endpoints from tracing
+    path = sampling_context.get("wsgi_environ", {}).get("PATH_INFO", "")
+    if path.rstrip("/") in SENTRY_TRACES_IGNORE_PATHS:
+        return 0
+
+    # Use configured sample rate for all other requests
+    return SENTRY_TRACES_SAMPLE_RATE or 0
+
+
+if env("SENTRY_DSN"):
+    sentry_sdk.init(
+        dsn=env("SENTRY_DSN"),
+        environment=env("SENTRY_ENVIRONMENT"),
+        release=env("SENTRY_RELEASE"),
+        integrations=[DjangoIntegration()],
+        traces_sampler=sentry_traces_sampler,
+        profile_session_sample_rate=env("SENTRY_PROFILE_SESSION_SAMPLE_RATE"),
+        profile_lifecycle="trace",
+    )
 
 MEDIA_ROOT = env("MEDIA_ROOT")
 STATIC_ROOT = env("STATIC_ROOT")
@@ -270,6 +299,12 @@
 CORS_ALLOWED_ORIGIN_REGEXES = env.list("CORS_ALLOWED_ORIGIN_REGEXES")
 CORS_ALLOW_ALL_ORIGINS = env.bool("CORS_ALLOW_ALL_ORIGINS")
 
+CORS_ALLOW_HEADERS = (
+    *default_headers,
+    "baggage",
+    "sentry-trace",
+)
+
 # Configure default CSP rules for different source types
 CSP_BLOB = "blob:"
 CSP_DATA = "data:"