Turbogears

Installing Airbrake in a Turbogears application

Turbogears

The pybrake package makes it quick and easy to monitor your Turbogears 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 of dependency

  • backlash: Turbogears integration uses trace and therefore requires library.
pip install -u backlash

Step 2: Install the latest version of pybrake

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

pip install -U pybrake

Step 3: Configure the Pybrake Turbogears middleware

First, import the Turbogears middleware from the pybrake package

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

:param app: Instance of Turbogears application to configure error monitoring 
              and APM
"""

Next, configure pybrake parameters and register middleware into your application

For Minimal Application Configuration

base_config.update_blueprint({
    'PYBRAKE': {
        "project_id": 99999,
        "project_key": "xxxxxxxxxxxxxxxxx",
    },
})

base_config = init_app(base_config)

Now you are ready to start reporting errors and performance events to Airbrake from your Turbogears app. Please look into minimal and fullstack 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.