summary refs log tree commit diff
path: root/contrib/prometheus/README
diff options
context:
space:
mode:
authorKrombel <krombel@krombel.de>2017-11-14 19:59:26 +0100
committerKrombel <krombel@krombel.de>2017-11-14 19:59:26 +0100
commitc161472575909b2fd21984778c7bbdc8dbe7632e (patch)
treec6cfa437b651a2136f8ed8590d45ed4190a98f14 /contrib/prometheus/README
parentupdate prometheus-config to new format (diff)
downloadsynapse-c161472575909b2fd21984778c7bbdc8dbe7632e.tar.xz
Make clear that the config has changed since prometheus v2
This restores the config that is usable for prometheus pre v2.0.0
The new config only works for Prometheus v2+
Diffstat (limited to 'contrib/prometheus/README')
-rw-r--r--contrib/prometheus/README16
1 files changed, 14 insertions, 2 deletions
diff --git a/contrib/prometheus/README b/contrib/prometheus/README
index d2ddb3f6e4..7b733172e6 100644
--- a/contrib/prometheus/README
+++ b/contrib/prometheus/README
@@ -5,7 +5,19 @@ To use it, first install prometheus by following the instructions at
 
   http://prometheus.io/
 
-Then add a new job to the main prometheus.yml file:
+### for Prometheus v1
+Add a new job to the main prometheus.conf file:
+
+  job: {
+    name: "synapse"
+
+    target_group: {
+      target: "http://SERVER.LOCATION.HERE:PORT/_synapse/metrics"
+    }
+  }
+
+### for Prometheus v2
+Add a new job to the main prometheus.yml file:
 
   - job_name: "synapse"
     metrics_path: "/_synapse/metrics"
@@ -18,7 +30,7 @@ Then add a new job to the main prometheus.yml file:
 To use `synapse.rules` add
 
     rule_files:
-      - "/PATH/TO/synapse.rules"
+      - "/PATH/TO/synapse-v2.rules"
 
 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