chore: set up Sentry

Author: afeld

appcontainer/requirements.txt

@@ -5,4 +5,5 @@ eligibility-api==2023.01.1
 opencensus-ext-azure==1.1.6
 opencensus-ext-django==0.8.0
 requests==2.28.2
+sentry-sdk==1.15.0
 six==1.16.0

benefits/settings.py

@@ -3,6 +3,8 @@
 """
 import os
 import benefits.logging
+import sentry_sdk
+from sentry_sdk.integrations.django import DjangoIntegration
 
 
 def _filter_empty(ls):
@@ -227,6 +229,26 @@ def _filter_empty(ls):
 LOG_LEVEL = os.environ.get("DJANGO_LOG_LEVEL", "DEBUG" if DEBUG else "WARNING")
 LOGGING = benefits.logging.get_config(LOG_LEVEL, enable_azure=ENABLE_AZURE_INSIGHTS)
 
+SENTRY_DSN = os.environ.get("SENTRY_DSN")
+if SENTRY_DSN:
+    print("Enabling Sentry…")
+
+    sentry_sdk.init(
+        dsn=SENTRY_DSN,
+        integrations=[
+            DjangoIntegration(),
+        ],
+        # Set traces_sample_rate to 1.0 to capture 100%
+        # of transactions for performance monitoring.
+        # We recommend adjusting this value in production.
+        traces_sample_rate=1.0,
+        # If you wish to associate users to errors (assuming you are using
+        # django.contrib.auth) you may enable sending PII data.
+        send_default_pii=True,
+    )
+else:
+    print("SENTRY_DSN not set, so won't send events")
+
 # Analytics configuration
 
 ANALYTICS_KEY = os.environ.get("ANALYTICS_KEY")

benefits/urls.py

@@ -16,12 +16,20 @@
 handler404 = "benefits.core.views.page_not_found"
 handler500 = "benefits.core.views.server_error"
 
+
+# based on
+# https://docs.sentry.io/platforms/python/guides/django/#verify
+def trigger_error(request):
+    raise RuntimeError("Test error")
+
+
 urlpatterns = [
     path("", include("benefits.core.urls")),
     path("eligibility/", include("benefits.eligibility.urls")),
     path("enrollment/", include("benefits.enrollment.urls")),
     path("i18n/", include("django.conf.urls.i18n")),
     path("oauth/", include("benefits.oauth.urls")),
+    path("sentry-debug/", trigger_error),
 ]
 
 if settings.ADMIN:

docs/configuration/environment-variables.md

@@ -171,3 +171,13 @@ Enables [log collection](../../deployment/troubleshooting/#logs). Set the value
 [app-service-config]: https://docs.microsoft.com/en-us/azure/app-service/configure-common?tabs=portal
 [benefits-secrets]: https://github.com/cal-itp/benefits-secrets
 [getting-started_create-env]: ../getting-started/README.md#create-an-environment-file
+
+## Sentry
+
+### `SENTRY_DSN`
+
+!!! tldr "Sentry docs"
+
+    [Data Source Name (DSN)](https://docs.sentry.io/product/sentry-basics/dsn-explainer/)
+
+Enables [sending events to Sentry](../../deployment/troubleshooting/#error-monitoring).

docs/deployment/troubleshooting.md

@@ -45,6 +45,12 @@ az webapp log tail --resource-group RG-CDT-PUB-VIP-CALITP-P-001 --name AS-CDT-PU
 
 <https://as-cdt-pub-vip-calitp-p-001-dev.scm.azurewebsites.net/api/logs/docker>
 
+### Sentry
+
+Cal-ITP's Sentry instance collects both [errors ("Issues")](https://sentry.calitp.org/organizations/sentry/issues/?project=3) and app [performance info](https://sentry.calitp.org/organizations/sentry/performance/?project=3).
+
+[Alerts are sent to #benefits-notify in Slack.](https://sentry.calitp.org/organizations/sentry/alerts/rules/benefits/9/details/) [Others can be configured.](https://sentry.calitp.org/organizations/sentry/alerts/rules/)
+
 ## Specific issues
 
 This section serves as the [runbook](https://www.pagerduty.com/resources/learn/what-is-a-runbook/) for Benefits.