celerymon

celerymon is a server that exposes Prometheus metrics for Celery tasks.

Motivation

Flower and celery-exporter both expose Prometheus metrics. We want to create yet another Celery metric exporter for the same reason as celery-exporter.

Mechanism

There are three ways to observe Celery:

• Using the underlying broker directly.

  As suggested in https://docs.celeryq.dev/en/stable/userguide/monitoring.html, this is the only way to measure the queue length.

• Using the Celery worker inspection API.

  Celery provides an RPC mechanism to talk to workers, and we can ask existing workers to check the currently executing tasks.

• Using the Celery events.

  Worker and task senders are optionally configured to send events. This requires an opt-in, but is real-time. Since this is an event stream, if an event consumer (like this monitoring tool) restarts, it won't be able to see the previous or current stats.

These three can cover different areas. By querying the broker directly, we can get the queued items stats. By using the worker inspection API, we can get the currently executing tasks. By using the Celery events, we can receive the stats on the finished tasks. celerymon uses all these three to get the data.

Limitations

• Because Celery events are sent only when workers and senders are configured so, if they are not configured, celerymon cannot receive events. For workers, celerymon periodically re-configures them to send events, but the senders are not configurable from it.

  While celerymon periodically re-configures workers to send events, relying on this means there can be a time gap between workers' start and reconfiguration. During this gap, the worker won't send events, which makes a hole in monitoring. If possible, configure workers to send events from the beginning.

• This is not specific to celerymon, but in general, this type of monitoring tools are not suited for short-lived ephemeral containers, such as Cloud Run. The background threads need to run continuously instead of just at the time a request is coming.

• Right now, part of celerymon is coupled to Redis as a broker. Looking at celery-exporter's code, there are ways to make this support more broker types. Just because we use Redis as a broker, currently only supports Redis.

Metrics

Name	Type	Labels
celerymon_redis_last_updated_timestamp_seconds	Gauge
celerymon_redis_queue_item_count	Gauge	queue_name, priority
celerymon_inspect_last_updated_timestamp_seconds	Gauge
celerymon_inspect_oldest_started_task_timestamp_seconds	Gauge	task_name
celerymon_inspect_worker_held_task_count	Gauge	task_name, state
celerymon_events_last_received_timestamp_seconds	Gauge	task_name, event_name
celerymon_events_count	Counter	task_name, event_name
celerymon_events_success_task_runtime_seconds	Histogram	task_name

There are timestamp metrics. These are meant to be used for checking the monitoring health. If this stops updating, it means that the monitoring cannot receive signals from those sources.

See the source code for the metric descriptions as well.

Usage

celerymon --broker-url=BROKER_URL
          --queue=QUEUE_NAME
          [--worker-inspect-interval-sec=10]
          [--redis-watch-interval-sec=10]
          [--healthz-unhealthy-threshold-sec=300]
          [--port=8000]

Note on /healthz

We recognize that Celery event stops working at some point for reasons unknown. To address this, celerymon serves /healthz that you can use as a health check endpoint that reacts to the inactivity. As described above, celerymon uses three data sources for providing the data. If one of them cannot be updated for --healthz-unhealthy-threshold-sec, this endpoint returns 500. You can configure your container management tool to restart the container based on this endpoint.

Stability

This is created Sep 2023. It's a new effort.