Added sentry for error monitoring

docker-compose.yml

@@ -41,6 +41,7 @@ services:
       - DJANGO_SETTINGS_MODULE=puzzlehunt_server.settings.env_settings
       - DATABASE_URL=postgres://${DB_USER}:${DB_PASSWORD}@db/${DB_NAME}
       - ENABLE_DEBUG_TOOLBAR
+      - SENTRY_DSN
     depends_on:
       - db
       - redis
@@ -58,6 +59,7 @@ services:
       - DJANGO_SECRET_KEY
       - DJANGO_SETTINGS_MODULE=puzzlehunt_server.settings.env_settings
       - DATABASE_URL=postgres://${DB_USER}:${DB_PASSWORD}@db/${DB_NAME}
+      - SENTRY_DSN
     depends_on:
       - app
 

puzzlehunt_server/settings/base_settings.py

@@ -163,3 +163,15 @@
 if os.environ.get("ENABLE_DEBUG_TOOLBAR"):
     INSTALLED_APPS = INSTALLED_APPS + ('debug_toolbar',)
     MIDDLEWARE = ('debug_toolbar.middleware.DebugToolbarMiddleware',) + MIDDLEWARE
+
+if os.environ.get("SENTRY_DSN"):
+    import sentry_sdk
+    from sentry_sdk.integrations.django import DjangoIntegration
+
+    sentry_sdk.init(
+        dsn=os.environ.get("SENTRY_DSN"),
+        integrations=[DjangoIntegration()],
+
+        # Sends which user caused the error
+        send_default_pii=True
+    )

requirements.txt

@@ -15,3 +15,4 @@ dj-database-url
 django-redis
 redis
 huey
+sentry-sdk==0.14.2

sample.env

@@ -5,6 +5,7 @@ DB_USER=user
 DJANGO_SECRET_KEY=mysecretkey
 DJANGO_EMAIL_USER=email_user
 DJANGO_EMAIL_PASSWORD=email_password
+DJANGO_ENABLE_DEBUG=False
 
 # DJANGO_ENABLE_DEBUG True
 # DJANGO_USE_SHIBBOLETH True
@@ -13,5 +14,7 @@ DOMAIN=your.domain-here.com
 CONTACT_EMAIL=sample_email@example.com
 PROJECT_NAME=puzzlehunt_site
 
-#COMPOSE_FILE=docker-compose.yml:docker/local_override.yml
-#COMPOSE_FILE=docker-compose.yml:docker/shib_override.yml:docker/proxy_override.yml
+# SENTRY_DSN=https://some_long_hex_string@sentry.io/some_number
+
+# COMPOSE_FILE=docker-compose.yml:docker/local_override.yml
+# COMPOSE_FILE=docker-compose.yml:docker/shib_override.yml:docker/proxy_override.yml