Adapt README

tschaefer · Jan 15, 2025 · dbaad91 · dbaad91
1 parent 8dfe30a
commit dbaad91
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -237,6 +237,19 @@ curl --request POST \
   https://supervisor.example.com/stacks/<stack_uuid>/control
 ```
 
+### Metrics
+
+To retrieve Prometheus metrics, you can access the
+`http://supervisor.example.com:9394/metrics` endpoint.
+
+  * `superrvisor_total_stacks`: The total number of stacks. (gauge)
+  * `supervisor_total_healthy_stacks`: The total number of healthy stacks. (gauge)
+  * `supervisor_total_unhealthy_stacks`: The total number of unhealthy stacks. (gauge)
+  * `supervisor_jobs_execution_time`: The time taken to execute stack jobs, measured in seconds. (histogram)
+  * `supervisor_jobs_executed_total`: The total number of stack jobs executed. (counter)
+  * `supervisor_jobs_succeeded_total`: The total number of stack jobs that succeeded. (counter)
+  * `supervisor_jobs_failed_total`: The total number of stack jobs that failed. (counter)
+
 ## Dashboard
 
 Supervisor provides a simple dashboard to view and monitor stacks. The