summary refs log tree commit diff
path: root/contrib/prometheus/README
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2017-09-05 17:51:13 +0100
committerRichard van der Hoff <richard@matrix.org>2017-09-05 17:51:13 +0100
commit4b616c8cf2d25db52843f43947421d5a8ee47ce5 (patch)
treee808d61355bf9da111c2bcc12a46f28520d87a81 /contrib/prometheus/README
parentfix python path in jenkins scripts (diff)
parentSet --python when running sytest (diff)
downloadsynapse-4b616c8cf2d25db52843f43947421d5a8ee47ce5.tar.xz
Merge branch 'master' into develop
Diffstat (limited to 'contrib/prometheus/README')
-rw-r--r--contrib/prometheus/README20
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.