Exports task execution metrics in Prometheus format
Project description
Exports task execution metrics in Prometheus format: how many tasks were started and have completed successfully or with failure, and how many tasks are still in the queues (supported only for broker redis).
Inspired by https://gitlab.com/kalibrr/celery-prometheus
Usage
Start HTTP service
Start the HTTP server like this:
$ bin/celery prometheus --host=127.0.0.1 --port=9691
Configure Prometheus
scrape_configs: - job_name: 'celery' static_configs: - targets: ['localhost:9691']
We export the following metrics:
celery_tasks_total{state="started|succeeded|failed|retried"}, counter
celery_task_queuetime_seconds, histogram (only if task_send_sent_event is enabled in Celery)
celery_task_runtime_seconds, histogram
If you pass --queuelength-interval=x then every x seconds the queue lengths will be checked (NOTE: this only works with redis as the broker), resulting in this additional metric:
celery_queue_length{queue="..."}, gauge
Run tests
Using tox and py.test. Maybe install tox (e.g. via pip install tox) and then simply run tox.
celery_redis_prometheus changes
1.1.1 (2020-03-20)
Fix py2 class syntax issues
1.1.0 (2020-03-20)
Make py2 compatible.
1.0.0 (2020-03-20)
Initial release
Project details
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_redis_prometheus-1.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 796e3b81c5bf3680a2a4dc30a2cf82e8f66d5fce8e9a63d4506e4599626e57a9 |
|
MD5 | b2a0e74483d06ab5dbed013a7cce09f8 |
|
BLAKE2b-256 | f77b04022f3af2f9de2862946823b15472ee7fb65848c32137c4d66b116f1272 |