Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Update docs to make enabling metrics more clear #13678

Merged
merged 3 commits into from
Sep 2, 2022
Merged

Update docs to make enabling metrics more clear #13678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
94cb2ac
Update docs to make enabling metrics more clear
MadLittleMods Aug 30, 2022
1ef9c08
Add changelog
MadLittleMods Aug 30, 2022
51d9716
Fix typo
MadLittleMods Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/13678.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update docs to make enabling metrics more clear.
11 changes: 7 additions & 4 deletions docs/metrics-howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very aside to this PR, but I wonder why we even need/want this flag in the first place?
Shouldn't it be enough to have a metrics listener? I can't see why you'd want to change them independently...

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
Expand Down Expand Up @@ -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.
Expand Down