Add sentry support

biothings_annotator/application/cli/target.py

@@ -16,9 +16,10 @@
 
 from sanic import Sanic
 
-from biothings_annotator.application.views import build_routes
-from biothings_annotator.application.middleware import build_middleware
 from biothings_annotator.application.exceptions import build_exception_handers
+from biothings_annotator.application.listeners import build_listeners
+from biothings_annotator.application.middleware import build_middleware
+from biothings_annotator.application.views import build_routes
 
 logging.basicConfig()
 logger = logging.getLogger("sanic-application")
@@ -85,6 +86,15 @@ class Sanic(
             logger.error("Unable to add middleware %s", middleware)
             raise gen_exc
 
+    application_listeners = build_listeners()
+    for listener in application_listeners:
+        try:
+            application.register_listener(**listener)
+        except Exception as gen_exc:
+            logger.exception(gen_exc)
+            logger.error("Unable to add listener %s", listener)
+            raise gen_exc
+
     exception_handlers = build_exception_handers()
     for exception_handler in exception_handlers:
         try:

biothings_annotator/application/configuration/default.json

@@ -7,6 +7,9 @@
             "REQUEST_MAX_SIZE": 100000000,
             "CACHE_MAX_AGE": 604800
         },
+        "sentry": {
+            "SENTRY_CLIENT_KEY": ""
+        },
         "extension": {
             "openapi": {
                 "OAS": true,

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

@@ -41,6 +41,8 @@ classifiers = [
 dependencies = [
     "biothings_client >= 0.4.0",
     "sanic[ext] >= 23.12.1",
+    "sentry-sdk[sanic] >= 2.19.0"
+
 ]