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.

Source Distribution

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file django-airbrake-1.3.0.tar.gz.

File metadata

File hashes

Hashes for django-airbrake-1.3.0.tar.gz
Algorithm Hash digest
SHA256 0dcf55dfc631bbfa54c94888cdf3c7afb6ffdc956631cd4af9142c57c3a029dd
MD5 9119b2ddb71e5cc5f4bc16d56b2cc4f3
BLAKE2b-256 740c261201fdf594aba16a8ba0fb626940f2940b66c54847209080bb700d780d

See more details on using hashes here.

File details

Details for the file django_airbrake-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_airbrake-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91a35291c64955587340529ec13d7193093f3d1b3a92849eeac528b5a1d35e67
MD5 0e060e564a8394c671db84502f27bcc7
BLAKE2b-256 eaba4fde28d3d646d7d416117c2120911f92db8319190bfc448a5a46e862d1b2

See more details on using hashes here.

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