summary refs log tree commit diff
diff options
context:
space:
mode:
authorSean Enck <enckse@gmail.com>2017-04-21 11:03:32 -0400
committerSean Enck <enckse@gmail.com>2017-04-21 11:03:32 -0400
commit719aec406487c9eb7942ce8c6a12a046218e93e2 (patch)
tree356be7e3ee72007f22f5258b6bfe1f948de7321c
parentDocument some of the admin APIs (#2143) (diff)
downloadsynapse-719aec406487c9eb7942ce8c6a12a046218e93e2.tar.xz
clarify metric setup to use 'scrape_configs' section of yaml and use an array for target
-rw-r--r--docs/metrics-howto.rst5
1 files changed, 2 insertions, 3 deletions
diff --git a/docs/metrics-howto.rst b/docs/metrics-howto.rst
index 7390ab85c9..143cd0f42f 100644
--- a/docs/metrics-howto.rst
+++ b/docs/metrics-howto.rst
@@ -21,13 +21,12 @@ How to monitor Synapse metrics using Prometheus
 
 3. Add a prometheus target for synapse.
 
-   It needs to set the ``metrics_path`` to a non-default value::
+   It needs to set the ``metrics_path`` to a non-default value (under ``scrape_configs``)::
 
     - job_name: "synapse"
       metrics_path: "/_synapse/metrics"
       static_configs:
-        - targets:
-            "my.server.here:9092"
+        - targets: ["my.server.here:9092"]
 
    If your prometheus is older than 1.5.2, you will need to replace 
    ``static_configs`` in the above with ``target_groups``.