Adds honeybadger support.

The Dockerfile is required to be in a non-slim image because honeybadger
introduces a dependency that is natively built. We will likely run into
these things, anyway.

Adds the `honeybadger` Python library to `requirements.txt`

New configuration option via env to provide the honeybadger project key
within the `HONEYBADGER_API_KEY` variable.

Sets it up to log all exceptions that are unhandled within the app.

Sets it up to log all CRITICAL logs that happen in the app.

Sets it up to log all ERROR logs (that aren't exceptions) in the app.

Author: wilkie

Dockerfile

@@ -1,6 +1,8 @@
-FROM python:3.11-slim
+FROM python:3.11
 
-RUN pip install Flask
+# We cannot use a '3.x-slim' image because we want 'gcc' installed for
+# certain packages. For instance, 'honeybadger' requires gcc via a
+# dependency on 'psutil'.
 
 WORKDIR /app
 COPY requirements.txt .

README.md

@@ -25,6 +25,11 @@ to `DEBUG`, `INFO`, `WARNING`, `ERROR`, or `CRITICAL`. The `DEBUG` setting is th
 most permissive and shows all logging text. The `CRITICAL` prevents most logging
 from happening. Most logging happens at `INFO`, which is the default setting.
 
+To enable Honeybadger reporting for events in the application, provide the
+`HONEYBADGER_API_KEY` within the configuration or as an environment variable. When
+enabled, the application will notify on Exceptions raised and any `error` or `critical`
+logs.
+
 ## Local Development
 
 All of our server code is written using [Flask](https://flask.palletsprojects.com/en/2.3.x/).

config.txt.sample

@@ -1,2 +1,3 @@
 OPENAI_API_KEY=
 LOG_LEVEL=INFO
+#HONEYBADGER_API_KEY=hbp_xxx

requirements.txt

@@ -2,3 +2,4 @@ numpy
 openai
 flask
 waitress
+honeybadger

src/__init__.py

@@ -12,8 +12,9 @@
 # Flask
 from flask import Flask
 
-# OpenAI library
-import openai
+# Honeybadger support
+from honeybadger.contrib import FlaskHoneybadger
+from honeybadger.contrib.logger import HoneybadgerHandler
 
 def create_app(test_config=None):
     # create and configure the app
@@ -42,6 +43,35 @@ def create_app(test_config=None):
     logging.log(100, f"Setting up application. Logging level={log_level}")
     logging.basicConfig(format='%(asctime)s: %(levelname)s:%(name)s:%(message)s', level=log_level)
 
+    # Add Honeybadger support
+    if os.getenv('HONEYBADGER_API_KEY'):
+        logging.info('Setting up Honeybadger configuration')
+
+        # I need to patch Flask in order for Honeybadger to load
+        # The honeybadger library uses this deprecated attribute
+        # It was deprecated because it is now always 'True'.
+        # See: https://github.com/pallets/flask/commit/04994df59f2f642e52ba46ca656088bcdb931262
+        from flask import signals
+        setattr(signals, 'signals_available', True)
+
+        # Log exceptions to Honeybadger
+        app.config['HONEYBADGER_API_KEY'] = os.getenv('HONEYBADGER_API_KEY')
+        app.config['HONEYBADGER_PARAMS_FILTERS'] = 'password, secret, openai_api_key, api_key'
+        app.config['HONEYBADGER_ENVIRONMENT'] = os.getenv('FLASK_ENV')
+        FlaskHoneybadger(app, report_exceptions=True)
+
+        # Also log ERROR/CRITICAL logs to Honeybadger
+        class NoExceptionErrorFilter(logging.Filter):
+            def filter(self, record):
+                # But ignore Python logging exceptions on 'ERROR'
+                return not record.getMessage().startswith('Exception on ')
+
+        hb_handler = HoneybadgerHandler(api_key=os.getenv('HONEYBADGER_API_KEY'))
+        hb_handler.setLevel(logging.ERROR)
+        hb_handler.addFilter(NoExceptionErrorFilter())
+        logger = logging.getLogger()
+        logger.addHandler(hb_handler)
+
     # Index (a simple HTML response that will always succeed)
     @app.route('/')
     def root():

src/test.py

@@ -17,6 +17,24 @@ def index():
 def test():
     return {}
 
+# A simple failing request
+@test_routes.route('/test/exception')
+def test_exception():
+    raise Exception("This is a test")
+    return {}
+
+# A simple post of an error message.
+@test_routes.route('/test/error')
+def test_error():
+    logging.error("This is an error log.")
+    return {}
+
+# A simple post of a critical message.
+@test_routes.route('/test/critical')
+def test_critical():
+    logging.critical("This is a critical log.")
+    return {}
+
 # Test numpy integration
 @test_routes.route('/test/numpy')
 def test_numpy():