Sentry

Author: SupraSummus

34-sentry.sh

@@ -0,0 +1,23 @@
+# install and configure sentry
+
+poetry add 'sentry-sdk[django]==*'
+
+
+# put some settings to configure sentry
+
+sed -i "/import environ/a import sentry_sdk" "$DJANGO_PROJECT_NAME/settings.py"
+
+cat <<EOF >> "$DJANGO_PROJECT_NAME/settings.py"
+
+SENTRY_DSN = env.str('SENTRY_DSN', default='')
+if SENTRY_DSN:
+    sentry_sdk.init(
+        dsn=SENTRY_DSN,
+        traces_sample_rate=0.01,
+    )
+EOF
+
+poetry run isort .
+
+git add --all
+git commit -m "Install and configure Sentry"

50-user-model.sh

@@ -20,7 +20,10 @@ EOL
 rm users/admin.py users/views.py users/tests.py
 
 # Update the settings.py file to use the custom user model
-echo "AUTH_USER_MODEL = 'users.User'" >> "$DJANGO_PROJECT_NAME/settings.py"
+cat <<EOF >> "$DJANGO_PROJECT_NAME/settings.py"
+
+AUTH_USER_MODEL = 'users.User'
+EOF
 
 # Create initial migration for the 'users' app
 poetry run env $(cat example.env) python manage.py makemigrations --no-header

everything.sh

@@ -16,5 +16,6 @@ source "$script_dir/31-0-django-environ.sh"
 source "$script_dir/31-5-django-https.sh"
 source "$script_dir/32-psycopg.sh"
 source "$script_dir/33-whitenoise.sh"
+source "$script_dir/34-sentry.sh"
 source "$script_dir/40-heroku.sh"
 source "$script_dir/50-user-model.sh"

example/commits.txt

@@ -67,6 +67,13 @@
  pyproject.toml      |  1 +
  4 files changed, 26 insertions(+), 1 deletion(-)
 
+--- Install and configure Sentry
+
+ example/settings.py |  8 ++++++
+ poetry.lock         | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
+ pyproject.toml      |  1 +
+ 3 files changed, 89 insertions(+), 1 deletion(-)
+
 --- Configure the project for Heroku deployment
 
  Procfile       |  2 ++
@@ -77,10 +84,10 @@
 
 --- Custom user model using UUID4 as the primary key
 
- example/settings.py              |  2 ++
+ example/settings.py              |  3 +++
  users/__init__.py                |  0
  users/apps.py                    |  6 ++++++
  users/migrations/0001_initial.py | 44 ++++++++++++++++++++++++++++++++++++++++
  users/migrations/__init__.py     |  0
  users/models.py                  |  8 ++++++++
- 6 files changed, 60 insertions(+)
+ 6 files changed, 61 insertions(+)

example/example/settings.py

@@ -13,6 +13,7 @@
 from pathlib import Path
 
 import environ
+import sentry_sdk
 
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
@@ -142,4 +143,12 @@
         "BACKEND": "whitenoise.storage.CompressedManifestStaticFilesStorage",
     },
 }
+
+SENTRY_DSN = env.str('SENTRY_DSN', default='')
+if SENTRY_DSN:
+    sentry_sdk.init(
+        dsn=SENTRY_DSN,
+        traces_sample_rate=0.01,
+    )
+
 AUTH_USER_MODEL = 'users.User'

example/poetry.lock

@@ -11,6 +11,7 @@ django = "*"
 django-environ = "*"
 psycopg = "*"
 whitenoise = "*"
+sentry-sdk = {version = "*", extras = ["django"]}
 gunicorn = "*"
 
 

example/pyproject.toml

@@ -22,5 +22,10 @@ cp example.env .env
 poetry run python manage.py collectstatic --no-input
 poetry run pytest
 
+# remove the virtual env, it may be stored outside the temporary directory
+poetry env remove --all
+
 # Navigate back to the original directory
 popd
+
+echo "All good!"