Skip to main content

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{queue}, histogram (only if task_send_sent_event is enabled in Celery)

  • celery_task_runtime_seconds{queue}, 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.5.0 (2023-10-27)

  • Be explicit about unregistering default collectors

1.4.0 (2022-10-28)

  • Add queue label to task_queuetime and task_runtime metrics

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.5.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.5.0
File Size Uploaded
celery_redis_prometheus-1.5.0.tar.gz 6.4 kB Details

Release files / celery_redis_prometheus-1.5.0.tar.gz

Download URL celery_redis_prometheus-1.5.0.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
047bd81e5c3962a0676641d6d2f7194ac42a2316084747217cba3bc01b132210
BLAKE2b-256 checksum
How to use checksums
685e9c9af7673fd8e7b384ce9e91282d05e795188c704ca28ec4a56b871efc3f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.6

Release history Release notifications | RSS feed

2.0.0

2 release files

1.5.2

2 release files

1.5.1

1 release file

This release

1.5.0 This release

1 release file

1.4.0

1 release file

1.3.0

1 release file

1.2.0

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page