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

Installation with pip:

$ pip install django-airbrake

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

LOGGING = {
    '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,
        },
    }
}

Settings

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)
api_url
To use aTech Media’s Codebase exception system, provide an extra setting api_url with the value 'https://exceptions.codebasehq.com/notifier_api/v2/notices'.
env_variables
List of environment variables that should be included in the error message, defaults to ['DJANGO_SETTINGS_MODULE'].
meta_variables
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
Timeout in seconds to send the error report, defaults to 30 seconds.

Contributing

  • Fork the repository on GitHub and start hacking.
  • Run the tests.
  • Send a pull request with your changes.

Releasing

The following actions are required to push a new version:

bumpversion [major|minor|patch]
python setup.py 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.

Files for django-airbrake, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size django_airbrake-1.3.0-py3-none-any.whl (4.7 kB) File type Wheel Python version 3.6 Upload date Hashes View
Filename, size django-airbrake-1.3.0.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page