Flask

Installing Airbrake in a Flask application

Flask

The pybrake package makes it quick and easy to monitor your Flask app’s performance. It only takes a few minutes to start collecting real performance data so let’s jump right in!

Key Features

  • Support for Airbrake Performance Monitoring
  • Simple to install and configure
  • Add extra context to errors before they are sent
  • Set error severity and control notification thresholds

Installation & Configuration

Set up the Pybrake’s middleware and project config for your web application

Step 1: Install the latest of dependency

  • Blinker: Flask integration uses Flask signals and therefore requires library.
pip install -u blinker

Step 2: Install the latest version of pybrake

Airbrake for Flask uses our official Python notifier pybrake. To install run:

pip install -U pybrake

Step 3: Configure the Airbrake Flask middleware

First, import the Flask middleware from the pybrake package

from pybrake.middleware.flask import init_app
"""
The pybrake provides middleware for error notification and APM.

:param app: Required the application instance to register error notifier and 
            APM to Flask application, example as below one.
"""

Next, configure pybrake parameters and register middleware into your application before application run

app.config['PYBRAKE'] = dict(
    project_id=123,
    project_key='FIXME',
)
app = init_app(app)

Now you are ready to start reporting errors and performance monitoring to Airbrake from your Flask app. Please look into sample example to get more idea.

Additional Settings

Please visit our Pybrake overview for details on useful features like:

Troubleshoot

If you have any questions or concerns, please address them here.