Use Sentry to report exceptions

Author: mars-f

docker-compose.yml

@@ -18,6 +18,8 @@ services:
       - TRANSPLANT_URL=https://stub.transplant.example.com
       - DATABASE_URL=sqlite:////db/sqlite.db
       - HOST_URL=https://lando-api.test
+      - ENV=localdev
+      - SENTRY_DSN=
     volumes:
       - ./:/app
       - ./.db/:/db/

landoapi/app.py

@@ -1,19 +1,24 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
+import json
 import os
 
 import click
 import connexion
 import logging
 
 from connexion.resolver import RestyResolver
+from raven.contrib.flask import Sentry
+
 from landoapi.dockerflow import dockerflow
 from landoapi.models.storage import alembic, db
 from mozlogging import MozLogFormatter
 
 logger = logging.getLogger(__name__)
 
+sentry = Sentry()
+
 
 def create_app(version_path):
     """Construct an application instance."""
@@ -24,9 +29,16 @@ def create_app(version_path):
 
     # Get the Flask app being wrapped by the Connexion app.
     flask_app = app.app
+
     flask_app.config['VERSION_PATH'] = version_path
     log_config_change('VERSION_PATH', version_path)
 
+    version_info = json.load(open(version_path))
+    logger.info(version_info, 'app.version')
+
+    this_app_version = version_info['version']
+    initialize_sentry(flask_app, this_app_version)
+
     db_uri = flask_app.config.setdefault(
         'SQLALCHEMY_DATABASE_URI', os.environ.get('DATABASE_URL', 'sqlite://')
     )
@@ -46,6 +58,39 @@ def create_app(version_path):
     return app
 
 
+def initialize_sentry(flask_app, release):
+    """Initialize Sentry application monitoring.
+
+    See https://docs.sentry.io/clients/python/advanced/#client-arguments for
+    details about what this function's arguments mean to Sentry.
+
+    Args:
+        flask_app: A Flask() instance.
+        release: A string representing this application release number (such as
+            a git sha).  Will be used as the Sentry "release" identifier. See
+            the Sentry client configuration docs for details.
+    """
+    sentry_dsn = os.environ.get('SENTRY_DSN', None)
+    if sentry_dsn:
+        log_config_change('SENTRY_DSN', sentry_dsn)
+    else:
+        log_config_change('SENTRY_DSN', 'none (sentry disabled)')
+
+    # Do this after logging the DSN so if there is a DSN URL parsing error
+    # the logs will record the configured value before the Sentry client
+    # kills the app.
+    sentry = Sentry(flask_app, dsn=sentry_dsn)
+
+    # Set these attributes directly because their keyword arguments can't be
+    # passed into Sentry.__init__() or make_client().
+    sentry.client.release = release
+    log_config_change('SENTRY_LOG_RELEASE_AS', release)
+
+    environment = os.environ.get('ENV', None)
+    sentry.client.environment = environment
+    log_config_change('SENTRY_LOG_ENVIRONMENT_AS', environment)
+
+
 def initialize_logging():
     """Initialize application-wide logging."""
     mozlog_handler = logging.StreamHandler()

requirements/common.txt

@@ -73,3 +73,11 @@ Flask-Alembic==2.0.1 \
 mozlogging==0.1.0 \
     --hash=sha256:2fc3d520a17b048c8723abdba19f6c01f2bcaf4182944aaac5906f28bd5b7d77 \
     --hash=sha256:2e1362b80418b845164d8d47337da838dade05720dbaf17956d1cafebc511b94
+raven[flask]==6.1.0 \
+    --hash=sha256:56dc9062dd42bca97350e5048ff417c914376366caa3b1b5f788b27ddc0a34b7 \
+    --hash=sha256:02cabffb173b99d860a95d4908e8b1864aad1b8452146e13fd7e212aa576a884
+contextlib2==0.5.5 \
+    --hash=sha256:f5260a6e679d2ff42ec91ec5252f4eeffdcf21053db9113bd0a8e4d953769c00 \
+    --hash=sha256:509f9419ee91cdd00ba34443217d5ca51f5a364a404e1dce9e8979cea969ca48
+blinker==1.4 \
+    --hash=sha256:471aee25f3992bd325afa3772f1063dbdbbca947a041b8b89466dc00d606f8b6