celery_redis_prometheus

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|retries-exceeded", queue="..."}, 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.3.0 (2022-09-14)

Add queue label to celery_tasks_total metric
Add separate state retries-exceeded (previously used failed)

1.2.0 (2022-06-23)

Update to celery-5.x

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

Metadata

Release files for celery_redis_prometheus 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for celery_redis_prometheus 1.3.0
File	Size	Uploaded
celery_redis_prometheus-1.3.0.tar.gz	7.4 kB	Sep 14, 2022	Details

Release files / celery_redis_prometheus-1.3.0.tar.gz

Download URL	celery_redis_prometheus-1.3.0.tar.gz
Size	7.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`9acc80734a6221dd8a96929dc708307a87b2e10fad5346ea492fec3d5703328a`
BLAKE2b-256 checksum How to use checksums	`7b1487318061869ce26041ade451e2d7850888bf5ab2e64092c0492b75207164`
Upload date	Sep 14, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.9.14`