Python SDK for airbrake.io
Project description
Airbrake integration for python that quickly and easily plugs into your existing code.
import airbrake
logger = airbrake.getLogger()
try:
1/0
except Exception:
logger.exception("Bad math.")airbrake-python is used most effectively through its logging handler, and uses the Airbrake V3 API for error reporting.
install
To install airbrake-python, run:
$ pip install -U airbrakesetup
The easiest way to get set up is with a few environment variables:
export AIRBRAKE_API_KEY=*****
export AIRBRAKE_PROJECT_ID=12345
export AIRBRAKE_ENVIRONMENT=devand you’re done!
Otherwise, you can instantiate your AirbrakeHandler by passing these values as arguments to the getLogger() helper:
import airbrake
logger = airbrake.getLogger(api_key=*****, project_id=12345)
try:
1/0
except Exception:
logger.exception("Bad math.")setup for Airbrake On-Premise and other compatible back-ends (e.g. Errbit)
Airbrake Enterprise and self-hosted alternatives, such as Errbit, provide a compatible API.
You can configure a different endpoint than the default (https://airbrake.io) by either:
Setting an environment variable:
export AIRBRAKE_HOST=https://self-hosted.errbit.example.com/Or passing a host argument to the getLogger() helper:
import airbrake
logger = airbrake.getLogger(api_key=*****, project_id=12345, host="https://self-hosted.errbit.example.com/")adding the AirbrakeHandler to your existing logger
import logging
import airbrake
yourlogger = logging.getLogger(__name__)
yourlogger.addHandler(airbrake.AirbrakeHandler())by default, the ``AirbrakeHandler`` only handles logs level ERROR (40) and above
Additional Options
More options are available to configure this library.
export AIRBRAKE_ENVIRONMENT=staging
Or you can set it more explicitly when you instantiate the logger.
import airbrake
logger = airbrake.getLogger(api_key=*****, project_id=12345, environment='production')The available options are:
environment, defaults to env var AIRBRAKE_ENVIRONMENT
host, defaults to env var AIRBRAKE_HOST or https://airbrake.io
root_directory, defaults to None
timeout, defaults to 5. (Number of seconds before each request times out)
giving your exceptions more context
import airbrake
logger = airbrake.getLogger()
def bake(**goods):
try:
temp = goods['temperature']
except KeyError as exc:
logger.error("No temperature defined!", extra=goods)Using this library without a logger
from airbrake.notifier import Airbrake
ab = Airbrake(project_id=1234, api_key='fake')
try:
amazing_code()
except ValueError as e:
ab.notify(e)
except:
# capture all other errors
ab.capture()Running Tests Manually
Create your environment and install the test requirements
virtualenv venv source venv/bin/activate pip install . python setup.py test
To run via nose (unit/integration tests):
source venv/bin/activate pip install -r ./test-requirements.txt source venv/bin/activate nosetests
Run all tests, including multi-env syntax, and coverage tests.
pip install tox tox -v --recreate
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
