Skip to main content

Python exception notifier for Airbrake

Project description

Build Status

Installation

pybrake requires Python 3.5+.

pip install -U pybrake

Usage

Creating notifier:

import pybrake


notifier = pybrake.Notifier(project_id=123,
                            project_key='abc',
                            environment='production')

Sending errors to Airbrake:

try:
    raise ValueError('hello')
except Exception as err:
    future = notifier.notify(err)
    # future has type concurrent.futures.Future
    notice = future.result()

By default notify sends errors asynchronously using ThreadPoolExecutor and returns a concurrent.futures.Future, but synchronous API is also available:

notice = notifier.notify_sync(err)
if 'id' in notice:
    print(notice['id'])
else:
    print(notice['error'])

You can also set custom params on all reported notices:

def my_filter(notice):
    notice['params']['myparam'] = 'myvalue'
    return notice

notifier.add_filter(my_filter)

Or ignore notices:

def my_filter(notice):
    if notice['context']['environment'] == 'development':
        # Ignore notices in development environment.
        return None
    return notice

notifier.add_filter(my_filter)

Logging integration

pybrake provide logging handler that sends your logs to Airbrake:

import logging
import pybrake


airbrake_handler = pybrake.LoggingHandler(notifier=notifier,
                                          level=logging.ERROR)

logger = logging.getLogger('test')
logger.addHandler(airbrake_handler)

logger.error('something bad happened')

Development

Running tests:

pip install -r test-requirements.txt
pytest

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

pybrake-0.1.1.tar.gz (7.5 kB view details)

Uploaded Source

File details

Details for the file pybrake-0.1.1.tar.gz.

File metadata

  • Download URL: pybrake-0.1.1.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pybrake-0.1.1.tar.gz
Algorithm Hash digest
SHA256 69976ebda1961d1355e0ef980ccb3801350c38a7420ca7f6cfd264aa98a9e405
MD5 8a6e9a3ea83bd86e5b6c953f49a0ac22
BLAKE2b-256 2c37e2ef3b0fdc0647d4e88ad20cf0758fe02c0f2a773ac9d993dd3babab6cbb

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