Extension for AWS X-Ray SDK which enables tracing of Celery tasks
Project description
celery-aws-xray-sdk-extension
Celery signal handlers that integrate Celery task lifecycle with AWS X-Ray tracing.
There's a tiny example in the directory example
.
Installation
You can install it easily with pip
: pip install celery-aws-xray-sdk-extension
. For latest version visit PyPI.
Setup
This guide doesn't cover setting up AWS X-Ray SDK for Python or AWS X-Ray daemon. It's expected that you've already got some experience with it. If you don't have any experience with AWS X-Ray, please visit Amazon documentation.
- You have to have Celery signals enabled.
- Connect Celery signals to signal handlers from
celery_aws_xray_sdk_extension
module in your Celery setup. Example code is below this list. - You're good to go!
Connecting handlers to Celery signals
signals.after_task_publish.connect(xray_after_task_publish)
signals.before_task_publish.connect(xray_before_task_publish)
signals.task_failure.connect(xray_task_failure)
signals.task_postrun.connect(xray_task_postrun)
signals.task_prerun.connect(xray_task_prerun)
Development
Before making any changes, please prepare your environment (no global changes are made!) with make setup-dev
. Feel free to check what the target does in the Makefile
.
This repository uses Conventional Commits.
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.
Source Distribution
Hashes for celery-aws-xray-sdk-extension-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81e8a21259560074cb9dbfd54bf5d47b2d1ba0c64a54d959dd1d960e731186a5 |
|
MD5 | 1a3b29b5365b565e21b0d3ecbdb08806 |
|
BLAKE2b-256 | 36792c8e79a3dc175c9b5f55cacab14678e20037d13160fca6374d192e837acc |