Sanic

Installing Airbrake in a Sanic application

Sanic

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

Key Features

Installation & Configuration

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

Step 1: Install the latest version of pybrake

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

pip install -U pybrake

Step 2: Configure the Pybrake Sanic middleware

First, import the Sanic middleware from the pybrake package

from pybrake.middleware.sanic import init_app

"""
The pybrake provides middleware for error notification and APM.

:param config: Required the application instance to register error notifier 
                and APM to Celery application, example as below one.
:param sqlEngine: Pass SQLAlchemy's database engine instance to monitor 
                    query stats, default value will be None
"""

Next, configure pybrake parameters and register middleware into your application

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 Sanic 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.