Merge pull request #6 from eduNEXT/cag/prometheus

feat: allow to setup prometheus integration
eduNEXT · Aug 22, 2024 · 5cfef76 · 5cfef76
2 parents 944b821 + 0fb495d
commit 5cfef76
Show file tree

Hide file tree

Showing 4 changed files with 999 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -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
+
+Make sure to enable the ServiceMonitor resource to inform Prometheus to scrape metrics from the flower service
+
+```yaml
+CELERY_FLOWER_SERVICE_MONITOR: true
+```
+
 License
 *******