forked from MirrorHub/synapse
Update metrics-howto.rst
This commit is contained in:
parent
7efb38d1dd
commit
e556aefe0a
|
@ -1,24 +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/
|
|
||||||
|
|
||||||
2: Enable synapse metrics:
|
Follow instructions at http://prometheus.io/docs/introduction/install/
|
||||||
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:
|
|
||||||
|
|
||||||
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::
|
||||||
|
|
||||||
Restart synapse.
|
metrics_port: 9092
|
||||||
|
|
||||||
3: Add a prometheus target for synapse. It needs to set the ``metrics_path``
|
Also ensure that ``enable_metrics`` is set to ``True``.
|
||||||
to a non-default value::
|
|
||||||
|
Restart synapse.
|
||||||
|
|
||||||
|
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"
|
||||||
|
@ -26,6 +29,9 @@ 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``.
|
||||||
|
|
||||||
Standard Metric Names
|
Standard Metric Names
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue