Add Docs for Prometheus Stats (#268)

Signed-off-by: Lita Cho <lcho@lyft.com>
8 years ago · ac130697f5
parent 052cda2dad
commit ac130697f5
1 changed files with 6 additions and 0 deletions
--- a/docs/root/operations/admin.rst
+++ b/docs/root/operations/admin.rst
@ -141,3 +141,9 @@ The fields are:
  .. http:get:: /stats?format=json

  Outputs /stats in JSON format. This can be used for programmatic access of stats.
+
+  .. http:get:: /stats?format=prometheus
+
+  Outputs /stats in `Prometheus <https://prometheus.io/docs/instrumenting/exposition_formats/>`_
+  v0.0.4 format. This can be used to integrate with a Prometheus server. Currently, only counters and
+  gauges are outputed. Histograms will be outputed in a future update.