Celery
The Celery integration adds support for the Celery Task Queue System.
Just add CeleryIntegration()
to your integrations
list:
import sentry_sdk
from sentry_sdk.integrations.celery import CeleryIntegration
sentry_sdk.init(
dsn='https://examplePublicKey@o0.ingest.sentry.io/0',
integrations=[CeleryIntegration()]
)
Additionally, the Sentry Python SDK will set the transaction on the event to the task name, and it will improve the grouping for global Celery errors such as timeouts.
The integration will automatically report errors from all celery jobs.
Generally, make sure that the call to init
is loaded on worker startup, and not only in the module where your tasks are defined. Otherwise, the initialization happens too late and events might end up not being reported.
There are many valid ways to do this like, for example, using a signal like worker_process_init
, or by initializing the SDK in the configuration file loaded with Celery's --config
parameter.
To verify if your SDK is initialized on worker start, you can pass debug=True
to see extra output when the SDK is initialized. If the output appears during worker startup and not only after a task has started, then it's working properly.
Note on distributed tracing
Sentry uses custom message headers for distributed tracing. For Celery versions 4.x, with message protocol of version 1, this functionality is broken, and Celery fails to propagate custom headers to the worker. Protocol version 2, which is the default since Celery version 4.0, is not affected.
The fix for the custom headers propagation issue was introduced to Celery project (PR) starting with version 5.0.1. However, the fix was not backported to versions 4.x.
- Package:
- pypi:sentry-sdk
- Version:
- 2.12.0
- Repository:
- https://github.com/getsentry/sentry-python