Bugsnag

Warnings

• breaking Migrating from Bugsnag Python 3.x to 4.x requires Python 3.5+. Older Python versions are no longer supported. The `bugsnag.utils.ThreadLocals` utility has been removed.
  Fix: Upgrade Python to 3.5 or newer. Remove usage of `bugsnag.utils.ThreadLocals`. Review and update any uses of deprecated properties from 2.x which were removed in 4.x.
• breaking The `Configuration.send_environment` option is now `False` by default in v4.x, meaning request context (like environment variables) will not be sent unless explicitly enabled. Setting unknown properties via `bugsnag.configure(**kwargs)` is no longer supported and will cause an error.
  Fix: To send environment data, set `send_environment=True` in your configuration. Ensure all configuration properties passed to `configure()` are recognized by the library.
• breaking In Bugsnag 4.x, `use_ssl` and `Configuration.get_endpoint()` have been deprecated in favor of including the protocol (e.g., `https://`) directly in the `endpoint` configuration option.
  Fix: Replace `config.use_ssl = True` and `config.endpoint = 'my.example.com'` with `config.endpoint = 'https://my.example.com'`.
• gotcha Automatic detection of unhandled exceptions in threads relies on `threading.excepthook`, which is only supported in Python 3.8 and above. For older Python 3 versions, unhandled exceptions in non-main threads might not be automatically reported.
  Fix: For full coverage, ensure your application runs on Python 3.8+. Alternatively, manually wrap critical thread logic with `try...except` and `bugsnag.notify()` for older Python versions.
• gotcha It is crucial to use `params_filters` to prevent sensitive data (e.g., passwords, credit card numbers) from being sent to Bugsnag in your error reports.
  Fix: Configure `params_filters` in `bugsnag.configure()` with a list of strings whose matching keys should be filtered from payloads. Example: `bugsnag.configure(params_filters=['password', 'credit_card_number'])`.
• gotcha The introduction of `__all__` lists in Bugsnag 4.x may affect existing integrations that use `from bugsnag import *` by changing which symbols are exposed during a wildcard import.
  Fix: Avoid using `from bugsnag import *`. Instead, explicitly import only the necessary symbols (e.g., `import bugsnag` or `from bugsnag import notify`).

Install

• pip install bugsnag Install latest version

Imports

• bugsnag

  import bugsnag

  Main module for configuration and error notification.
• BugsnagHandler

  from bugsnag.handlers import BugsnagHandler

  Used to integrate Bugsnag with Python's standard logging framework.

Quickstart

This quickstart demonstrates basic Bugsnag configuration and how to manually report a handled exception. Ensure `BUGSNAG_API_KEY` is set in your environment or replace the placeholder.

import bugsnag
import os

bugsnag.configure(
    api_key=os.environ.get('BUGSNAG_API_KEY', 'YOUR_API_KEY_HERE'),
    release_stage='development',
    project_root=os.path.dirname(os.path.abspath(__file__)),
)

def might_fail():
    raise ValueError("This is a test error!")

try:
    might_fail()
except Exception as e:
    print(f"Caught an error: {e}. Notifying Bugsnag...")
    bugsnag.notify(e)
    print("Notification sent.")

# To demonstrate unhandled error reporting, you would typically not catch it.
# For example, simply calling might_fail() outside a try-except block in a WSGI/ASGI app.