Capturing logs and events
Honeybadger’s Python package (v1.1+) can be used to send events to Honeybadger Insights.
Automatic instrumentation
Section titled “Automatic instrumentation”Honeybadger Insights allows you to automatically track various events in your application. To enable Insights automatic instrumentation, add the following to your configuration:
from honeybadger import honeybadger
honeybadger.configure(insights_enabled=True)Supported libraries
Section titled “Supported libraries”After integration with our middleware or extensions, Honeybadger will automatically instrument the following libraries:
- Django requests & database queries
- Flask requests & database queries
- ASGI requests
- Celery tasks
You can configure the instrumentation for specific libraries / components by
passing a dictionary to a specialized insights_config parameter.
By default, all keyword dict params are run through our params_filters.
Django
Section titled “Django”Django instrumentation captures these event types:
django.request db.query
Database events are configured in their own section, but are emitted automatically by the Django instrumentation.
You can configure the Django instrumentation by passing a dictionary to
insights_config:
honeybadger.configure( insights_config={ "django": { # Disable instrumentation for Django, defaults to False "disabled": True, # include GET/POST params in events, defaults to False "include_params": True, } })Flask instrumentation captures these event types:
flask.request db.query
Database events are configured in their own section, but are emitted automatically by the Flask instrumentation.
You can configure the Flask instrumentation by passing a dictionary to
insights_config:
honeybadger.configure( insights_config={ "flask": { # Disable instrumentation for Flask, defaults to False "disabled": True, # Include GET/POST params in events, defaults to False "include_params": True, } })ASGI instrumentation captures these event types:
asgi.request
You can configure the ASGI instrumentation by passing a dictionary to
insights_config:
honeybadger.configure( insights_config={ "asgi": { # Disable instrumentation for ASGI, defaults to False "disabled": True, # Include query params in events, defaults to False "include_params": True, } })Celery
Section titled “Celery”Celery instrumentation captures these event types:
celery.task_finished
You can configure the Celery instrumentation by passing a dictionary to
insights_config:
import refrom honeybadger import honeybadger
honeybadger.configure( insights_config={ "celery": { # Disable instrumentation for Celery, defaults to False "disabled": True, # Include task args/kwargs, defaults to False "include_args": True, # List of task names or regexes to exclude, defaults to [] "exclude_tasks": [ "tasks.cleanup", re.compile("^internal_"), ], } })Database
Section titled “Database”Honeybadger can capture database queries for supported libraries like Django ORM and SQLAlchemy. The event types captured include:
db.query
These events are emitted as a side effect other instrumentation, such as Django or Flask, so you don’t need to enable them separately.
You can configure the database instrumentation by passing a dictionary to
insights_config:
import refrom honeybadger import honeybadgerfrom honeybadger.config import default_excluded_queries
honeybadger.configure( insights_config={ "db": { # Disable instrumentation for DB, defaults to False "disabled": True, # Include SQL params in events, defaults to False "include_params": True,
# List of queries to exclude (strings or regexes), defaults to # common system queries "exclude_queries": [ "django_admin_log", # Matches any query containing this string re.compile(r".*auth_permission.*"), # Regex pattern ],
# To add to the default excluded queries, import and use the default_excluded_queries function "exclude_queries": default_excluded_queries() + [ re.compile(r".*my_custom_table.*"), "my_system_query", ], } })Send custom events to Honeybadger Insights
Section titled “Send custom events to Honeybadger Insights”Use honeybadger.event method to send custom events to
Honeybadger Insights. This allows you to track and monitor
important events in your application.
from honeybadger import honeybadger
# Send a simple eventhoneybadger.event('user.signup', {'email': 'user@example.com'})
# Send an event with additional metadatahoneybadger.event( 'order.completed', { 'order_id': '123', 'total': 49.99, 'items': ['item1', 'item2'] })
# Or pass everything as a dictionaryhoneybadger.event({ 'event_type': 'order.completed', 'order_id': '123', 'total': 49.99, 'items': ['item1', 'item2']})The event method can be called in two ways:
- With two parameters:
event_type(string) anddata(dictionary) - With one parameter: a dictionary containing
event_typeand any additional data
We recommend event_type for grouping your events. A ts timestamp is
automatically added to events if not present, using the current UTC time in ISO
8601 format.
For more information about configuring Insights and events, see Insights Configuration.
Sending logs from your infrastructure
Section titled “Sending logs from your infrastructure”Honeybadger isn’t just for errors and application data! You can use our syslog, Vector, or PaaS integrations to send additional data from your infrastructure to Honeybadger Insights, where you can query, visualize, and analyze all of your production data in one place.