From 5700c351e8154d8ea1548e730ba21d2ceecce2e3 Mon Sep 17 00:00:00 2001
From: Graham Christensen <graham@grahamc.com>
Date: Thu, 10 Jun 2021 20:13:08 -0400
Subject: [PATCH] Init a docs section for monitoring, document
 queue-runner-status and the prometheus metrics

---
 doc/manual/src/SUMMARY.md           |  1 +
 doc/manual/src/monitoring/README.md | 15 +++++++++++++++
 2 files changed, 16 insertions(+)
 create mode 100644 doc/manual/src/monitoring/README.md

diff --git a/doc/manual/src/SUMMARY.md b/doc/manual/src/SUMMARY.md
index f0dc77a4..586c09aa 100644
--- a/doc/manual/src/SUMMARY.md
+++ b/doc/manual/src/SUMMARY.md
@@ -4,6 +4,7 @@
 - [Installation](installation.md)
 - [Creating and Managing Projects](projects.md)
 - [Using the external API](api.md)
+- [Monitoring Hydra](./monitoring/README.md)
 -----------
 [About](about.md)
 [Hacking](hacking.md)
diff --git a/doc/manual/src/monitoring/README.md b/doc/manual/src/monitoring/README.md
new file mode 100644
index 00000000..65872352
--- /dev/null
+++ b/doc/manual/src/monitoring/README.md
@@ -0,0 +1,15 @@
+# Monitoring Hydra
+
+## Webserver
+
+The webserver exposes Prometheus metrics for the webserver itself at `/metrics`.
+
+## Queue Runner
+
+The queue runner's status is exposed at `/queue-runner-status`:
+
+```console
+$ curl --header "Accept: application/json" http://localhost:63333/queue-runner-status
+... JSON payload ...
+```
+