diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2017-09-25 11:50:11 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-25 11:50:11 +0100 |
| commit | 94133d7ce8ab8dca8b8f47c0f2666d59486884a5 (patch) | |
| tree | d472d3d5530e45eee0c156a0446bf42da0a81288 /contrib/prometheus/README | |
| parent | Fix iteration of requests_missing_keys; list doesn't have .values() (diff) | |
| parent | Fix logcontxt leak in keyclient (#2465) (diff) | |
| download | synapse-94133d7ce8ab8dca8b8f47c0f2666d59486884a5.tar.xz | |
Merge branch 'develop' into develop
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. |