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

Update metrics-howto.rst

Browse source
This commit is contained in:
Richard van der Hoff 2017-02-19 23:06:08 +00:00 committed by GitHub
parent 7efb38d1dd
commit e556aefe0a
1 changed files with 18 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/metrics-howto.rst
View file

@ -1,24 +1,27 @@
How to monitor Synapse metrics using Prometheus
===============================================
1: Install prometheus:
Follow instructions at http://prometheus.io/docs/introduction/install/
1. Install prometheus:
2: Enable synapse metrics:
Simply setting a (local) port number will enable it. Pick a port.
prometheus itself defaults to 9090, so starting just above that for
locally monitored services seems reasonable. E.g. 9092:
Follow instructions at http://prometheus.io/docs/introduction/install/
Add to homeserver.yaml::
2. Enable synapse metrics:
metrics_port: 9092
Simply setting a (local) port number will enable it. Pick a port.
prometheus itself defaults to 9090, so starting just above that for
locally monitored services seems reasonable. E.g. 9092:
Also ensure that ``enable_metrics`` is set to ``True``.
Add to homeserver.yaml::
metrics_port: 9092
Also ensure that ``enable_metrics`` is set to ``True``.
Restart synapse.
Restart synapse.
3: Add a prometheus target for synapse. It needs to set the ``metrics_path``
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"
metrics_path: "/_synapse/metrics"
@ -26,6 +29,9 @@ How to monitor Synapse metrics using Prometheus
- targets:
"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``.
Standard Metric Names
---------------------