diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2017-08-22 10:34:40 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-08-22 10:34:40 +0100 |
| commit | 77ea8cbdd7202d75538623c79b3d33119221d02b (patch) | |
| tree | 9837c16b82240ce00e51f635747c7a40df5a1359 /contrib/prometheus/README | |
| parent | Merge pull request #2413 from matrix-org/toml-issue-template (diff) | |
| parent | Add prometheus config (diff) | |
| download | synapse-77ea8cbdd7202d75538623c79b3d33119221d02b.tar.xz | |
Merge pull request #2416 from matrix-org/rav/prometheus_config
Add prometheus config
Diffstat (limited to 'contrib/prometheus/README')
| -rw-r--r-- | contrib/prometheus/README | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/contrib/prometheus/README b/contrib/prometheus/README new file mode 100644 index 0000000000..eb91db2de2 --- /dev/null +++ b/contrib/prometheus/README @@ -0,0 +1,20 @@ +This directory contains some sample monitoring config for using the +'Prometheus' monitoring server against synapse. + +To use it, first install prometheus by following the instructions at + + http://prometheus.io/ + +Then add a new job to the main prometheus.conf file: + + job: { + name: "synapse" + + target_group: { + target: "http://SERVER.LOCATION.HERE:PORT/_synapse/metrics" + } + } + +Metrics are disabled by default when running synapse; they must be enabled +with the 'enable-metrics' option, either in the synapse config file or as a +command-line option. |