diff options
| author | Erik Johnston <erik@matrix.org> | 2017-09-19 11:07:45 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2017-09-19 11:07:45 +0100 |
| commit | b5feaa5a494e7f3fb1a0607002df54e4f17d20da (patch) | |
| tree | eae4a91e78c9215631fde08c69c4b2dd093c44e6 /contrib/prometheus/README | |
| parent | Merge pull request #2430 from matrix-org/erikj/groups_profile_cache (diff) | |
| parent | Fix overzealous kicking of guest users (#2453) (diff) | |
| download | synapse-b5feaa5a494e7f3fb1a0607002df54e4f17d20da.tar.xz | |
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/groups_merged
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. |