Add sentry support (#66)

* Add sentry listener for the webapp

* Add listener support for hooking into the application instance

* Add various sentry dependencies


---------

Co-authored-by: jschaff <jschaff@scripps.edu>

Author: ctrl-schaff

biothings_annotator/application/configuration/default.json

@@ -7,6 +7,9 @@
             "REQUEST_MAX_SIZE": 100000000,
             "CACHE_MAX_AGE": 604800
         },
+        "sentry": {
+            "SENTRY_CLIENT_KEY": ""
+        },
         "extension": {
             "cors": {
                 "CORS_ALLOW_HEADERS": "*",

biothings_annotator/application/listeners/__init__.py

@@ -0,0 +1,13 @@
+from typing import Dict, List
+
+from .sentry import initialize_sentry
+
+
+def build_listeners() -> List[Dict]:
+    """
+    Basic method for aggregating all of listeners created
+    for the annotator service
+    """
+    sentry_listener = {"listener": initialize_sentry, "event": "before_server_start", "priority": 0}
+    listener_collection = [sentry_listener]
+    return listener_collection

biothings_annotator/application/listeners/sentry.py

@@ -0,0 +1,39 @@
+"""
+Listener for configuring the sentry support for the
+sanic web-app associated with the annotator service
+"""
+
+import sanic
+
+import sentry_sdk
+from sentry_sdk.integrations.asyncio import AsyncioIntegration
+from sentry_sdk.integrations.sanic import SanicIntegration
+
+
+async def initialize_sentry(application_instance: sanic.Sanic) -> None:
+    """
+    Listener for initializing our sentry logging
+
+    Set the sample rate for transactions
+    https://docs.sentry.io/platforms/python/configuration/options/#traces-sample-rate
+
+    Set the profiles sample rate for transactions
+    https://docs.sentry.io/platforms/python/profiling/
+    """
+    # https://docs.sentry.io/platforms/python/integrations/asyncio/
+    async_integration = AsyncioIntegration()
+
+    # https://docs.sentry.io/platforms/python/integrations/sanic/
+    sanic_integration = SanicIntegration(
+        # Configure the Sanic integration so that we generate
+        # transactions for all HTTP status codes, including 404
+        unsampled_statuses=None,
+    )
+    sentry_configuration = application_instance.config.get("sentry", {})
+    sentry_key = sentry_configuration.get("SENTRY_CLIENT_KEY", "")
+    sentry_sdk.init(
+        dsn=sentry_key,
+        traces_sample_rate=0.20,
+        profiles_sample_rate=0.20,
+        integrations=[async_integration, sanic_integration],
+    )

pyproject.toml

@@ -44,7 +44,8 @@ classifiers = [
 ]
 dependencies = [
     "biothings_client >= 0.4.0",
-    "sanic[ext] == 24.12.0"
+    "sanic[ext] == 24.12.0",
+    "sentry-sdk[sanic] >= 2.19.0",
 ]
 
 
@@ -54,7 +55,7 @@ tests = [
     "pytest-asyncio >= 0.23.8",
     "pytest-randomly",
     "sanic-testing >= 24.6.0",
-    "pytest-randomly"
+    "pytest-randomly",
 ]
 
 
@@ -64,7 +65,7 @@ tests = [
 
 [tool.black]
 line-length = 120
-target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312', 'py313', 'py314']
 extend-exclude = '''
 # A regex preceded with ^/ will apply only to files and directories
 # in the root of the project.