Skip to main content

Airbrake exception logger for Django

Project description

Build Status Test Coverage PyPI

Django Airbrake provides a logging handler to push exceptions and other errors to airbrakeapp or other airbrake-compatible exception handler services (e.g. aTech Media’s Codebase).

Compatible with all supported Django (LTS) versions. At the moment of writing that’s including 1.11 and 2.0 on Python 2.7(only django1.11), 3.4, 3.5 and 3.6.


Installation with pip:

$ pip install django-airbrake

Add 'airbrake.handlers.AirbrakeHandler' as a logging handler:

    'version': 1,
    'disable_existing_loggers': False,
    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse'
    'handlers': {
        'airbrake': {
            'level': 'WARNING',
            'class': 'airbrake.handlers.AirbrakeHandler',
            'filters': ['require_debug_false'],
            'api_key': '[your-api-key]',
            'env_name': 'develop',
    'loggers': {
        'django.request': {
            'handlers': ['airbrake'],
            'level': 'WARNING',
            'propagate': True,


level (built-in setting) Change the level to 'ERROR' to disable logging of 404 error messages.

api_key (required)

API key provided by the exception handler system.

env_name (required)

Name of the environment (e.g. production, develop, testing)


To use aTech Media’s Codebase exception system, provide an extra setting api_url with the value ''.


List of environment variables that should be included in the error message, defaults to ['DJANGO_SETTINGS_MODULE'].


List of request.META variables that should be included in the error message, defaults to ['HTTP_USER_AGENT', 'HTTP_COOKIE', 'REMOTE_ADDR', 'SERVER_NAME', 'SERVER_SOFTWARE'].


Timeout in seconds to send the error report, defaults to 30 seconds.


  • Fork the repository on GitHub and start hacking.

  • Run the tests.

  • Send a pull request with your changes.


The following actions are required to push a new version:

bumpversion [major|minor|patch]
python sdist bdist_wheel upload
git push

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-airbrake-1.3.0.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distribution

django_airbrake-1.3.0-py3-none-any.whl (4.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page