Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2024-12-24 23:49:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/master' into develop

Browse Source
This commit is contained in:
Richard van der Hoff 2017-02-20 09:14:43 +00:00
commit 11940d462a
1 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/metrics-howto.rst
View File

@ -1,22 +1,27 @@
How to monitor Synapse metrics using Prometheus How to monitor Synapse metrics using Prometheus
=============================================== ===============================================
1: Install prometheus: 1. Install prometheus:
Follow instructions at http://prometheus.io/docs/introduction/install/ Follow instructions at http://prometheus.io/docs/introduction/install/
2: Enable synapse metrics: 2. Enable synapse metrics:
Simply setting a (local) port number will enable it. Pick a port. Simply setting a (local) port number will enable it. Pick a port.
prometheus itself defaults to 9090, so starting just above that for prometheus itself defaults to 9090, so starting just above that for
locally monitored services seems reasonable. E.g. 9092: locally monitored services seems reasonable. E.g. 9092:
Add to homeserver.yaml Add to homeserver.yaml::
metrics_port: 9092 metrics_port: 9092
Restart synapse Also ensure that ``enable_metrics`` is set to ``True``.
3: Add a prometheus target for synapse. It needs to set the ``metrics_path`` Restart synapse.
to a non-default value::
3. Add a prometheus target for synapse.
It needs to set the ``metrics_path`` to a non-default value::
- job_name: "synapse" - job_name: "synapse"
metrics_path: "/_synapse/metrics" metrics_path: "/_synapse/metrics"
@ -24,6 +29,11 @@ How to monitor Synapse metrics using Prometheus
- targets: - targets:
"my.server.here:9092" "my.server.here:9092"
If your prometheus is older than 1.5.2, you will need to replace
``static_configs`` in the above with ``target_groups``.
Restart prometheus.
Standard Metric Names Standard Metric Names
--------------------- ---------------------