Add Sentry integration

lokiunimore/config/config.py

@@ -202,6 +202,16 @@ def OIDC_EMAIL_REGEX(val: str) -> re.Pattern:
     return re.compile(val)
 
 
+@config.optional()
+def SENTRY_DSN(val: str | None) -> str | None:
+    """
+    The DSN to use to connect to Sentry.
+    If not specified, the Sentry integration is disabled.
+    https://docs.sentry.io/platforms/python/
+    """
+    return val
+
+
 __all__ = (
     "config",
     "MATRIX_HOMESERVER",
@@ -223,4 +233,5 @@ def OIDC_EMAIL_REGEX(val: str) -> re.Pattern:
     "OIDC_API_BASE_URL",
     "OIDC_SCOPES",
     "OIDC_EMAIL_REGEX",
+    "SENTRY_DSN",
 )

lokiunimore/matrix/__main__.py

@@ -3,8 +3,11 @@
 from lokiunimore.utils.logs import install_log_handler
 from lokiunimore.matrix.client import LokiClient
 from lokiunimore.config import MATRIX_USER_SECRET, MATRIX_HOMESERVER, MATRIX_USER_ID, SQLALCHEMY_DATABASE_URL
+from lokiunimore.utils.errors import install_sentry
 
 install_log_handler()
+install_sentry()
+
 loop = asyncio.new_event_loop()
 
 

lokiunimore/utils/errors.py

@@ -0,0 +1,36 @@
+import sentry_sdk
+import sentry_sdk._types as sentry_typing
+import sentry_sdk.integrations.flask
+import sentry_sdk.integrations.sqlalchemy
+import pkg_resources
+import socket
+
+from lokiunimore.config import SENTRY_DSN
+
+
+version = pkg_resources.get_distribution("lokiunimore").version
+
+
+def clean_events(event: sentry_typing.Event, hint: sentry_typing.Hint):
+    # TODO: Clean events so that they do not leak personal information
+    ...
+
+
+def install_sentry():
+    sentry_sdk.init(
+        dsn=SENTRY_DSN.__wrapped__,
+        server_name=socket.gethostname(),
+        debug=__debug__,
+        release=f"{version}+dev" if __debug__ else version,
+        environment="Development" if __debug__ else "Production",
+        integrations=(
+            sentry_sdk.integrations.flask.FlaskIntegration(),
+            sentry_sdk.integrations.sqlalchemy.SqlalchemyIntegration(),
+        ),
+        before_send=clean_events,
+    )
+
+
+__all__ = (
+    "sentry"
+)

lokiunimore/web/__main__.py

@@ -1,9 +1,11 @@
 import flask.logging
 import lokiunimore.utils.logs
 
+from lokiunimore.utils.errors import install_sentry
 from .app import app
 
 lokiunimore.utils.logs.install_log_handler(app.logger)
 app.logger.removeHandler(flask.logging.default_handler)
+install_sentry()
 
 app.run(host="127.0.0.1", port=30008, debug=True)

pyproject.toml

@@ -142,6 +142,7 @@ psycopg2 = "^2.9.3"
 matrix-nio = "^0.19.0"
 cfig = {extras = ["cli"], version = "^0.3.0"}
 python-dotenv = "^0.21.0"
+sentry-sdk = {extras = ["flask"], version = "^1.9.8"}