Starlette

Installing Airbrake in a Starlette application

Starlette

The pybrake package makes it quick and easy to monitor your Starlette 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 Starlette uses our official Python notifier pybrake. To install run:

pip install -U pybrake

Step 2: Configure the Pybrake Starlette middleware

First, import the Starlette middleware from the pybrake package

from pybrake.middleware.starlette import init_app
"""
Initiate the pybrake notifier and apply the patch for error monitoring and APM.

:param app: Instance of Starlette application to configure error monitoring 
              and APM
:param sqlEngine: SQLALCHEMY engine instance if you want to monitor query 
                    stats, default value will be None
"""

Next, configure pybrake parameters and register middleware into your application

app = Starlette()
app.state.PYBRAKE = dict(
    project_id=123,
    project_key='FIXME',
)
app = init_app(app)

Now you are ready to start reporting errors and performance events to Airbrake from your Starlette 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.