Metadata-Version: 1.1
Name: django-airbrake
Version: 1.0.0
Summary: Airbrake exception logger for django
Home-page: http://github.com/Bouke/django-airbrake
Author: Bouke Haarsma
Author-email: bouke@webatoom.nl
License: MIT
Description: ===============
        Django Airbrake
        ===============
        
        .. image:: https://travis-ci.org/Bouke/django-airbrake.png?branch=develop
            :alt: Build Status
            :target: https://travis-ci.org/Bouke/django-airbrake
        
        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). Django 1.4 and 1.5 on Python 2.7 are
        supported, while support Django 1.5 on Python 3.3 is experimental.
        
        Django 1.3 on Python 2.6 was supported until version 0.3.0.
        
        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.
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: System :: Logging
