From 94cb2aca3ca831875b7b23f3f9de2d415b5ec5af Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Tue, 30 Aug 2022 18:40:57 -0500 Subject: [PATCH 1/3] Update docs to make enabling metrics more clear --- docs/metrics-howto.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/metrics-howto.md b/docs/metrics-howto.md index 4a77d5604c39..478e6aa4a520 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 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. From 1ef9c0849397e4fa1e7392a33b9bb28e4cebc2d5 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Tue, 30 Aug 2022 18:43:03 -0500 Subject: [PATCH 2/3] Add changelog --- changelog.d/13678.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/13678.doc diff --git a/changelog.d/13678.doc b/changelog.d/13678.doc new file mode 100644 index 000000000000..8b85dfe643bc --- /dev/null +++ b/changelog.d/13678.doc @@ -0,0 +1 @@ +Update docs to make enabling metrics more clear. From 51d97167e08de41842b53c3b96005b22e7058ad4 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Tue, 30 Aug 2022 18:43:47 -0500 Subject: [PATCH 3/3] Fix typo --- docs/metrics-howto.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/metrics-howto.md b/docs/metrics-howto.md index 478e6aa4a520..279303a7988e 100644 --- a/docs/metrics-howto.md +++ b/docs/metrics-howto.md @@ -13,7 +13,7 @@ 1. Enable the `/_synapse/metrics` Synapse endpoint that Prometheus uses to collect data: - There are two methods of enabling metrics endpoint in Synapse. + 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