feat(sentry): update sentry configuration

Refs: HAUKI-710

Author: danipran

config_dev.env.example

@@ -139,7 +139,17 @@ STATIC_URL=/static/
 
 # Sentry environment is an optional tag that can be included in sentry
 # reports. It is used to separate deployments within Sentry UI
-SENTRY_ENVIRONMENT=local-development-unconfigured
+SENTRY_ENVIRONMENT=local
+
+# Sentry profile session sample rate determines the percentage of profiling sessions
+# that are sampled for performance monitoring. Set as a float between 0.0 (0%) and 1.0 (100%).
+# You probably want to use a lower rate in production.
+# SENTRY_PROFILE_SESSION_SAMPLE_RATE=1.0
+
+# Sentry traces sample rate determines the percentage of transactions that are sampled
+# for performance monitoring. Set as a float between 0.0 (0%) and 1.0 (100%).
+# You probably want to use a lower rate in production.
+# SENTRY_TRACES_SAMPLE_RATE=1.0
 
 # Mailgun API credentials
 # If Hauki incorporates the django notificator app https://github.com/City-of-Helsinki/django-ilmoitin,

hauki/settings.py

@@ -8,9 +8,11 @@
 
 import environ
 import sentry_sdk
+from corsheaders.defaults import default_headers
 from django.conf.global_settings import LANGUAGES as GLOBAL_LANGUAGES
 from django.core.exceptions import ImproperlyConfigured
 from sentry_sdk.integrations.django import DjangoIntegration
+from sentry_sdk.types import SamplingContext
 
 CONFIG_FILE_NAME = "config_dev.env"
 
@@ -65,7 +67,10 @@ def get_git_revision_hash() -> str:
     STATIC_URL=(str, "/static/"),
     TRUST_X_FORWARDED_HOST=(bool, False),
     SENTRY_DSN=(str, ""),
-    SENTRY_ENVIRONMENT=(str, "development"),
+    SENTRY_ENVIRONMENT=(str, "local"),
+    SENTRY_PROFILE_SESSION_SAMPLE_RATE=(float, None),
+    SENTRY_RELEASE=(str, None),
+    SENTRY_TRACES_SAMPLE_RATE=(float, None),
     COOKIE_PREFIX=(str, "hauki"),
     INTERNAL_IPS=(list, []),
     INSTANCE_NAME=(str, "Hauki"),
@@ -178,14 +183,36 @@ def get_git_revision_hash() -> str:
     "drf_spectacular",
 ] + env("EXTRA_INSTALLED_APPS")
 
+
+SENTRY_TRACES_SAMPLE_RATE = env.float("SENTRY_TRACES_SAMPLE_RATE")
+
+
+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 ["/healthz", "/readiness"]:
+        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=get_git_revision_hash(),
+        dsn=env.str("SENTRY_DSN"),
+        environment=env.str("SENTRY_ENVIRONMENT"),
+        release=env.str("SENTRY_RELEASE"),
         integrations=[DjangoIntegration()],
+        traces_sampler=sentry_traces_sampler,
+        profile_session_sample_rate=env.str("SENTRY_PROFILE_SESSION_SAMPLE_RATE"),
+        profile_lifecycle="trace",
     )
 
+
 MIDDLEWARE = [
     # CorsMiddleware should be placed as high as possible and above WhiteNoiseMiddleware
     # in particular
@@ -294,6 +321,11 @@ def get_git_revision_hash() -> str:
 SECURE_PROXY_SSL_HEADER = env("SECURE_PROXY_SSL_HEADER")
 
 CORS_ALLOW_ALL_ORIGINS = True
+CORS_ALLOW_HEADERS = (
+    *default_headers,
+    "baggage",
+    "sentry-trace",
+)
 CSRF_COOKIE_NAME = f"{env('COOKIE_PREFIX')}-csrftoken"
 SESSION_COOKIE_NAME = f"{env('COOKIE_PREFIX')}-sessionid"