Add Bugsnag to your Celery tasks.
Using PyPI:
pip install bugsnag
Configure the library in your worker module
import bugsnag
bugsnag.configure(
api_key = "YOUR_API_KEY_HERE",
project_root = "/path/to/your/app"
)
You can find your API key in Project Settings.
Add the bugsnag failure handler to celery
from bugsnag.celery import connect_failure_handler
connect_failure_handler()
You can connect Bugsnag up to Python’s logging framework so that anything of level “error” or above is logged to Bugsnag.
Here is a plain Python example:
import logging
from bugsnag.handlers import BugsnagHandler
# ... (call bugsnag.configure() here)
logger = logging.getLogger("test.logger")
handler = BugsnagHandler()
# send only ERROR-level logs and above
handler.setLevel(logging.ERROR)
logger.addHandler(handler)
At this point, Bugsnag should be installed and configured, and any unhandled exceptions will be automatically detected and should appear in your Bugsnag dashboard.
If you would like to send handled exceptions to Bugsnag, you should import
the bugsnag module:
import bugsnag
Then to notify Bugsnag of an error, you can call bugsnag.notify:
bugsnag.notify(Exception("Something broke!"))
You can also pass additional configuration options in as named parameters. These parameters will only affect the current call to notify.
The metadata field is a dictionary of dictionaries which will be rendered as
a tab in a Bugsnag error report. This example would create a special_info
tab:
bugsnag.notify(Exception("Something broke!"),
context="myContext",
metadata={"special_info":{"request_id": 12345, "message_id": 854}}
)
For more information, see reporting handled errors.
The BugsnagHandler accepts a special keyword argument to its __init__()
function: extra_fields. This is optional and may be a dictionary of
extra attributes to gather from each LogRecord and insert into metadata
to be attached to Bugsnag error reports.
The keys in the extra_fields dictionary should be tab names for where you
would like the data displayed in Bugsnag, and the values should be attributes to
pull off each log record and enter into section. The attributes are not
required to exist on the log record, and any non-existent attribute will be
ignored. Example:
bs_handler = BugsnagHandler(extra_fields={"some_tab":["context_attribute"]})
This is very useful if you are assigning context-specific attributes to your LogRecord objects, as described in the python logging cookbook.
Bugsnag can track the number of “sessions” that happen within your application. This allows you to compare stability scores between releases and helps you to understand the quality of your releases.
You can start a session by calling bugsnag.start_session() at the start of an interval which should be considered a session.
bugsnag-python, the library
powering this integration, on GitHub