Documentation: add notes on metrics

Signed-off-by: Hank Donnay <hdonnay@redhat.com>
quay · Mar 23, 2022 · 9a74ac8 · 9a74ac8
1 parent d09b319
commit 9a74ac8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/Documentation/SUMMARY.md b/Documentation/SUMMARY.md
@@ -24,5 +24,4 @@
   - [Indexer](./reference/indexer.md)
   - [Matcher](./reference/matcher.md)
   - [Notifier](./reference/notifier.md)
-
-
+  - [Metrics](./reference/metrics.md)
diff --git a/Documentation/reference/metrics.md b/Documentation/reference/metrics.md
@@ -0,0 +1,6 @@
+Clair exports [metrics](./config.md#metrics) on the [introspection
+port](./config.md#introspection_addr) in the Prometheus format.
+
+The exact metrics exposed are not considered API (and so are subject to change
+between releases) but should be well described. An up-to-date grafana dashboard
+example is in `contrib/openshift/grafana`.