Add basic config for Sentry instrumentation

- Adds Django-specific sentry-sdk package in Pipfile
- Updates .env.example with hints for DSN
- Updates settings.py with the Sentry init and defaults for a development env

Author: korlaxxalrok

.env.example

@@ -12,6 +12,12 @@ CSRF_TRUSTED_ORIGINS='http://127.0.0.1:8000,http://localhost:8000'
 SECRET_KEY='secret_key'
 DEBUG='True'
 
+# Sentry
+# Modify the Sentry config here. A DSN string is the minimum. Check the
+# application's Sentry init section and the Sentry documentation and for the
+# defaults and options that may be set.
+DSN=''
+
 # Add the following to your local .env file. They will be used in the CI process
 # and you can largely forget about them, but including them in your .env file
 # will act like a safe default and help suppress warnings.

Pipfile

@@ -9,7 +9,7 @@ django-filter = "*"
 django-extensions = "*"
 pillow = "*"
 pre-commit = "*"
-sentry-sdk = "*"
+'sentry-sdk[django]' = "*"
 python-dotenv = "*"
 django-health-check = "*"
 django-cors-headers = "*"

src/signal_documentation/settings.py

@@ -10,9 +10,23 @@
 https://docs.djangoproject.com/en/4.2/ref/settings/
 """
 import os
+import sentry_sdk
 from pathlib import Path
 from typing import Any
 
+# Sentry init and config:
+# - Specify the DSN via the env var of `SENTRY_DSN`.
+# - Useful defaults for a development environment are set below. They can be
+#   changed by modifying env vars.
+sentry_sdk.init(
+    traces_sample_rate = os.environ.get('SENTRY_TRACES_SAMPLE_RATE', 1.0),
+    profiles_sample_rate = os.environ.get('SENTRY_PROFILES_SAMPLE_RATE', 1.0),
+    environment = os.environ.get('SENTRY_ENVIRONMENT', 'development'),
+    debug = os.environ.get('SENTRY_DEBUG', 'True'),
+    attach_stacktrace = os.environ.get('SENTRY_ATTACH_STACK_TRACE', 'True')
+)
+
+
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR: Path = Path(__file__).resolve().parent.parent
 
@@ -131,6 +145,7 @@
 
 # Django chache
 # https://docs.djangoproject.com/en/4.2/topics/cache/#redis
+
 CACHES: dict[str, dict[str, str]] = {
     'default': {
         'BACKEND': 'django.core.cache.backends.redis.RedisCache',