summary refs log tree commit diff
path: root/contrib/prometheus/README
diff options
context:
space:
mode:
authorRichard van der Hoff <github@rvanderhoff.org.uk>2017-11-14 19:14:32 +0000
committerGitHub <noreply@github.com>2017-11-14 19:14:32 +0000
commit038c9947246066d4737c31bb9278a25e963a24db (patch)
treefcec40f4920abe0f643ec7da2367ae0b4ba4552a /contrib/prometheus/README
parentMerge pull request #2671 from matrix-org/rav/room_list_fixes (diff)
parentMake clear that the config has changed since prometheus v2 (diff)
downloadsynapse-038c9947246066d4737c31bb9278a25e963a24db.tar.xz
Merge pull request #2648 from krombel/update_prometheus
update prometheus-config to new format
Diffstat (limited to 'contrib/prometheus/README')
-rw-r--r--contrib/prometheus/README19
1 files changed, 18 insertions, 1 deletions
diff --git a/contrib/prometheus/README b/contrib/prometheus/README
index eb91db2de2..7b733172e6 100644
--- a/contrib/prometheus/README
+++ b/contrib/prometheus/README
@@ -5,7 +5,8 @@ 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:
+### for Prometheus v1
+Add a new job to the main prometheus.conf file:
 
   job: {
     name: "synapse"
@@ -15,6 +16,22 @@ Then add a new job to the main prometheus.conf file:
     }
   }
 
+### for Prometheus v2
+Add a new job to the main prometheus.yml file:
+
+  - job_name: "synapse"
+    metrics_path: "/_synapse/metrics"
+    # when endpoint uses https:
+    scheme: "https"
+
+    static_configs:
+    - targets: ['SERVER.LOCATION:PORT']
+
+To use `synapse.rules` add
+
+    rule_files:
+      - "/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
 command-line option.