feat: add sentry sdk

.pre-commit-config.yaml

@@ -76,7 +76,7 @@ repos:
       - id: requirements.txt
         name: requirements.txt
         description: Generate requirements.txt
-        entry: tools/extract_requirements.py dev
+        entry: tools/extract_requirements.py dev sentry
         pass_filenames: false
         language: script
         files: setup.py$

Dockerfile

@@ -83,7 +83,7 @@ RUN --mount=type=cache,target=/root/.cache/pip \
 
 COPY analyzer .
 RUN --mount=type=cache,target=/root/.cache/pip \
-    pip install --editable .
+    pip install --editable .[sentry]
 
 # Run
 USER ${UID}:${GID}
@@ -122,7 +122,7 @@ RUN --mount=type=cache,target=/root/.cache/pip \
 
 COPY playout .
 RUN --mount=type=cache,target=/root/.cache/pip \
-    pip install --editable .
+    pip install --editable .[sentry]
 
 # Run
 USER ${UID}:${GID}
@@ -158,7 +158,7 @@ RUN --mount=type=cache,target=/root/.cache/pip \
 
 COPY api .
 RUN --mount=type=cache,target=/root/.cache/pip \
-    pip install --editable .[prod]
+    pip install --editable .[prod,sentry]
 
 # Run
 USER ${UID}:${GID}
@@ -191,7 +191,7 @@ RUN --mount=type=cache,target=/root/.cache/pip \
 
 COPY worker .
 RUN --mount=type=cache,target=/root/.cache/pip \
-    pip install --editable .
+    pip install --editable .[sentry]
 
 # Run
 USER ${UID}:${GID}

analyzer/Makefile

@@ -4,7 +4,7 @@ include ../tools/python.mk
 
 PIP_INSTALL := \
 	--editable ../shared \
-	--editable .[dev]
+	--editable .[dev,sentry]
 PYLINT_ARG := libretime_analyzer tests || true
 MYPY_ARG := libretime_analyzer tests || true
 BANDIT_ARG := libretime_analyzer || true

analyzer/libretime_analyzer/main.py

@@ -1,3 +1,5 @@
+import logging
+import os
 from pathlib import Path
 from typing import Optional
 
@@ -6,10 +8,13 @@ from libretime_shared.cli import cli_config_options, cli_logging_options
 from libretime_shared.config import DEFAULT_ENV_PREFIX
 from libretime_shared.logging import setup_logger
 
+from . import PACKAGE, VERSION
 from .config import Config
 from .message_listener import MessageListener
 from .status_reporter import StatusReporter
 
+logger = logging.getLogger(__name__)
+
 VERSION = "1.0"
 
 DEFAULT_RETRY_QUEUE_FILEPATH = Path("retry_queue")
@@ -36,6 +41,16 @@ def cli(
     setup_logger(log_level, log_filepath)
     config = Config(config_filepath)
 
+    if "SENTRY_DSN" in os.environ:
+        logger.info("installing sentry")
+        # pylint: disable=import-outside-toplevel
+        import sentry_sdk
+
+        sentry_sdk.init(
+            traces_sample_rate=1.0,
+            release=f"{PACKAGE}@{VERSION}",
+        )
+
     # Start up the StatusReporter process
     StatusReporter.start_thread(retry_queue_filepath)
 

analyzer/setup.py

@@ -30,6 +30,9 @@ setup(
             "distro>=1.8.0,<1.9",
             "types-requests>=2.25.1,<2.29",
         ],
+        "sentry": [
+            "sentry-sdk>=1.15.0,<1.16",
+        ],
     },
     zip_safe=False,
 )

api/Makefile

@@ -4,7 +4,7 @@ include ../tools/python.mk
 
 PIP_INSTALL := \
 	--editable ../shared \
-	--editable .[dev]
+	--editable .[dev,sentry]
 PYLINT_ARG := libretime_api
 MYPY_ARG := libretime_api
 BANDIT_ARG := --exclude '*/tests/*' libretime_api || true

api/libretime_api/settings/_internal.py

@@ -1,6 +1,8 @@
-from os import getenv
+from os import environ, getenv
 from typing import Optional
 
+from .. import PACKAGE, VERSION
+
 API_VERSION = "2.0.0"
 
 # SECURITY WARNING: don't run with debug turned on in production!
@@ -178,3 +180,18 @@ SPECTACULAR_SETTINGS = {
     "VERSION": API_VERSION,
     "ENUM_NAME_OVERRIDES": SPECTACULAR_ENUM_NAME_OVERRIDES,
 }
+
+# Sentry
+# https://docs.sentry.io/platforms/python/guides/django/
+if "SENTRY_DSN" in environ:
+    # pylint: disable=import-outside-toplevel
+    import sentry_sdk
+    from sentry_sdk.integrations.django import DjangoIntegration
+
+    sentry_sdk.init(
+        traces_sample_rate=1.0,
+        release=f"{PACKAGE}@{VERSION}",
+        integrations=[
+            DjangoIntegration(),
+        ],
+    )

api/setup.py

@@ -44,5 +44,8 @@ setup(
             "pytest-django>=4.5.2,<4.6",
             "requests-mock>=1.10.0,<1.11",
         ],
+        "sentry": [
+            "sentry-sdk[django]>=1.15.0,<1.16",
+        ],
     },
 )

playout/Makefile

@@ -6,7 +6,7 @@ APP := playout
 PIP_INSTALL := \
 	--editable ../api-client \
 	--editable ../shared \
-	--editable .[dev]
+	--editable .[dev,sentry]
 PYLINT_ARG := libretime_playout tests
 MYPY_ARG := libretime_playout tests || true
 BANDIT_ARG := libretime_playout || true

playout/libretime_playout/main.py

@@ -1,8 +1,8 @@
 """
 Python part of radio playout (pypo)
 """
-
 import logging
+import os
 import sys
 import time
 from datetime import datetime
@@ -18,6 +18,7 @@ from libretime_shared.cli import cli_config_options, cli_logging_options
 from libretime_shared.config import DEFAULT_ENV_PREFIX
 from libretime_shared.logging import setup_logger
 
+from . import PACKAGE, VERSION
 from .config import CACHE_DIR, RECORD_DIR, Config
 from .history.stats import StatsCollectorThread
 from .liquidsoap.client import LiquidsoapClient
@@ -75,6 +76,16 @@ def cli(
     setup_logger(log_level, log_filepath)
     config = Config(config_filepath)
 
+    if "SENTRY_DSN" in os.environ:
+        logger.info("installing sentry")
+        # pylint: disable=import-outside-toplevel
+        import sentry_sdk
+
+        sentry_sdk.init(
+            traces_sample_rate=1.0,
+            release=f"{PACKAGE}@{VERSION}",
+        )
+
     try:
         for dir_path in [CACHE_DIR, RECORD_DIR]:
             dir_path.mkdir(exist_ok=True)

playout/setup.py

@@ -41,6 +41,9 @@ setup(
             "types-python-dateutil>=2.8.1,<2.9",
             "types-requests>=2.25.1,<2.29",
         ],
+        "sentry": [
+            "sentry-sdk>=1.15.0,<1.16",
+        ],
     },
     zip_safe=False,
 )

worker/Makefile

@@ -4,7 +4,7 @@ include ../tools/python.mk
 
 PIP_INSTALL := \
 	--editable ../shared \
-	--editable .[dev]
+	--editable .[dev,sentry]
 PYLINT_ARG := libretime_worker
 MYPY_ARG := libretime_worker || true
 BANDIT_ARG := libretime_worker

worker/libretime_worker/tasks.py

@@ -1,4 +1,5 @@
 import json
+import os
 from email.message import EmailMessage
 from pathlib import Path
 from tempfile import NamedTemporaryFile
@@ -7,17 +8,35 @@ from urllib.parse import urlsplit
 
 import mutagen
 import requests
-from celery import Celery
+from celery import Celery, signals
 from celery.utils.log import get_task_logger
 from mutagen import MutagenError
 from requests import RequestException, Response
 
+from . import PACKAGE, VERSION
 from .config import config
 
 worker = Celery()
 logger = get_task_logger(__name__)
 
 
+@signals.worker_init.connect
+def init_sentry(**_kwargs):
+    if "SENTRY_DSN" in os.environ:
+        logger.info("installing sentry")
+        # pylint: disable=import-outside-toplevel
+        import sentry_sdk
+        from sentry_sdk.integrations.celery import CeleryIntegration
+
+        sentry_sdk.init(
+            traces_sample_rate=1.0,
+            release=f"{PACKAGE}@{VERSION}",
+            integrations=[
+                CeleryIntegration(),
+            ],
+        )
+
+
 @worker.task(name="podcast-download", acks_late=True)
 def podcast_download(
     episode_id: int,

worker/setup.py

@@ -25,6 +25,9 @@ setup(
             "requests-mock>=1.10.0,<1.11",
             "types-requests>=2.25.1,<2.29",
         ],
+        "sentry": [
+            "sentry-sdk>=1.15.0,<1.16",
+        ],
     },
     zip_safe=False,
 )