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.
|