Browse Source

Update docs to make enabling metrics more clear (#13678)

It was really easy to miss the `enable_metrics: True` step with the previous language.
Eric Eastwood 1 year ago
parent
commit
36b184b782
2 changed files with 8 additions and 4 deletions
  1. 1 0
      changelog.d/13678.doc
  2. 7 4
      docs/metrics-howto.md

+ 1 - 0
changelog.d/13678.doc

@@ -0,0 +1 @@
+Update docs to make enabling metrics more clear.

+ 7 - 4
docs/metrics-howto.md

@@ -7,7 +7,13 @@
 
 1.  Enable Synapse metrics:
 
-    There are two methods of enabling metrics in Synapse.
+    In `homeserver.yaml`, make sure `enable_metrics` is
+    set to `True`.
+
+1.  Enable the `/_synapse/metrics` Synapse endpoint that Prometheus uses to
+    collect data:
+
+    There are two methods of enabling the metrics endpoint in Synapse.
 
     The first serves the metrics as a part of the usual web server and
     can be enabled by adding the \"metrics\" resource to the existing
@@ -41,9 +47,6 @@
             - '0.0.0.0'
     ```
 
-    For both options, you will need to ensure that `enable_metrics` is
-    set to `True`.
-
 1.  Restart Synapse.
 
 1.  Add a Prometheus target for Synapse.