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 airbrake
setup
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=dev
and 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_BASE_URL=https://self-hosted.errbit.example.com/
Or passing a base_url argument to the getLogger() helper:
import airbrake
logger = airbrake.getLogger(api_key=*****, project_id=12345, base_url="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
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)
Project details
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.