summary refs log tree commit diff
diff options
context:
space:
mode:
authorEric Eastwood <erice@element.io>2022-09-02 11:29:51 -0500
committerGitHub <noreply@github.com>2022-09-02 11:29:51 -0500
commit36b184b78257fa4455293b7d7faa7a53a4261383 (patch)
tree2a32328680252d36230f117e1c33aa73f263de76
parentUpdate lock file for Poetry v1.2.0 (#13689) (diff)
downloadsynapse-36b184b78257fa4455293b7d7faa7a53a4261383.tar.xz
Update docs to make enabling metrics more clear (#13678)
It was really easy to miss the `enable_metrics: True` step with the previous language.
-rw-r--r--changelog.d/13678.doc1
-rw-r--r--docs/metrics-howto.md11
2 files changed, 8 insertions, 4 deletions
diff --git a/changelog.d/13678.doc b/changelog.d/13678.doc
new file mode 100644
index 0000000000..8b85dfe643
--- /dev/null
+++ b/changelog.d/13678.doc
@@ -0,0 +1 @@
+Update docs to make enabling metrics more clear.
diff --git a/docs/metrics-howto.md b/docs/metrics-howto.md
index 4a77d5604c..279303a798 100644
--- a/docs/metrics-howto.md
+++ b/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.