tileradotorg/synapse
1
0
Fork 0
forked from MirrorHub/synapse
Code Pull requests Activity

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

Browse source 
It was really easy to miss the `enable_metrics: True` step with the previous language.
This commit is contained in:
Eric Eastwood 2022-09-02 11:29:51 -05:00 committed by GitHub
parent 4fee4a339d
commit 36b184b782
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/13678.doc Normal file
View file

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

11
docs/metrics-howto.md
View file

@ -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 @@
- '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.