Skip to content

Commit

Permalink
feat: allow to enable prometheus integration (#8)
Browse files Browse the repository at this point in the history
* feat: allow to enable prometheus integration

* docs: add prometheus documentation and custom dashboard

* chore: address PR suggestions

* fix: address PR suggestions

* fix: address PR suggestions

* chore: disable flower monitoring by default

* chore: remove extra spaces

* chore: improve docs
  • Loading branch information
Ian2012 authored Aug 22, 2024
1 parent 9a46d7f commit 0c3a7c2
Show file tree
Hide file tree
Showing 4 changed files with 999 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,27 @@ times and performance:
CELERY_FLOWER: true
```

#### Enable Flower Prometheus Integration

If you are running grafana you can use the attached [config map](resources/configmap.yaml) to import a custom Grafana dashboard to monitor
celery metrics such as:

- Total Queue Length
- Queue Length by task name
- Celery Worker Status
- Number of Tasks Currently Executing at Worker
- Average Task Runtime at Worker
- Task Prefetch Time at Worker
- Number of Tasks Prefetched at Worker
- Tasks Success Ratio
- Tasks Failure Ratio

If you are using the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator) you can enable a ServiceMonitor resource to automatically configure a scrape target for the flower service.

```yaml
CELERY_FLOWER_SERVICE_MONITOR: true
```

License
*******

Expand Down
Loading

0 comments on commit 0c3a7c2

Please sign in to comment.