Skip to content
Snippets Groups Projects
Unverified Commit 36b184b7 authored by Eric Eastwood's avatar Eric Eastwood Committed by GitHub
Browse files

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

It was really easy to miss the `enable_metrics: True` step with the previous language.
parent 4fee4a33
Branches
Tags
No related merge requests found
Update docs to make enabling metrics more clear.
...@@ -7,7 +7,13 @@ ...@@ -7,7 +7,13 @@
1. Enable Synapse metrics: 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 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 can be enabled by adding the \"metrics\" resource to the existing
...@@ -41,9 +47,6 @@ ...@@ -41,9 +47,6 @@
- '0.0.0.0' - '0.0.0.0'
``` ```
For both options, you will need to ensure that `enable_metrics` is
set to `True`.
1. Restart Synapse. 1. Restart Synapse.
1. Add a Prometheus target for Synapse. 1. Add a Prometheus target for Synapse.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment