WSGI integration guide

Add Bugsnag to your WSGI applications.


Using PyPI:

pip install bugsnag

Basic configuration

Configure Bugsnag and attach the WSGI middleware:

# Configure Bugsnag
import bugsnag
from bugsnag.wsgi.middleware import BugsnagMiddleware

  api_key = "YOUR_API_KEY_HERE",
  project_root = "/path/to/your/app",

# Wrap your WSGI app with Bugsnag
application = BugsnagMiddleware(application)

Logging configuration

You can connect Bugsnag up to Python’s logging framework so that anything of level “error” or above is logged to Bugsnag.

Here is a plain Python example:

import logging

from bugsnag.handlers import BugsnagHandler

#call bugsnag.configure() here
logger = logging.getLogger("test.logger")

Reporting unhandled errors

At this point, Bugsnag should be installed and configured, and any unhandled exceptions will be automatically detected and should appear in your Bugsnag dashboard.

Reporting handled errors

If you would like to send handled exceptions to Bugsnag, you should import the bugsnag module:

import bugsnag

Then to notify Bugsnag of an error, you can call bugsnag.notify:

bugsnag.notify(Exception("Something broke!"))

You can also pass additional configuration options in as named parameters. These parameters will only affect the current call to notify.

Sending diagnostic data

Automatically captured diagnostics

As well as a full stacktrace for every exception, Bugsnag will automatically capture the following diagnostic data:

  • Request information, including ip, headers, URL, HTTP method, and HTTP params
  • Session data
  • Release stage (production, beta, staging, etc)
  • Hostname

Custom diagnostics

The meta_data field is a dictionary of dictionaries which will be rendered as a tab in a Bugsnag error report. This example would create a special_info tab:

bugsnag.notify(Exception("Something broke!"),
    meta_data={"special_info":{"request_id": 12345, "message_id": 854}}

For more information, see reporting handled errors.

Identifying users

The user field is information about the person currently using your application. It should be a dictionary containing id, email, and/or name.

bugsnag.notify(e, user={"id":"bob-hoskins", name: "Bob Hoskins", email: ""})

For more information, see reporting handled errors. To set user information for every report, see customizing error reports.

Next steps