summary refs log tree commit diff
path: root/contrib/prometheus/README.md
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2020-11-26 11:42:55 +0100
committerGitHub <noreply@github.com>2020-11-26 10:42:55 +0000
commit14f81a6d242204229934c9b7bff0ec6efb09c840 (patch)
tree52ec1985901ad1866f6a709fefe3fcae0f8ca501 /contrib/prometheus/README.md
parentRemove deprecated `/_matrix/client/*/admin` endpoints (#8785) (diff)
downloadsynapse-14f81a6d242204229934c9b7bff0ec6efb09c840.tar.xz
Improve documentation how to configure prometheus for workers (#8822)
Diffstat (limited to 'contrib/prometheus/README.md')
-rw-r--r--contrib/prometheus/README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/contrib/prometheus/README.md b/contrib/prometheus/README.md
index e646cb7ea7..b3f23bcc80 100644
--- a/contrib/prometheus/README.md
+++ b/contrib/prometheus/README.md
@@ -20,6 +20,7 @@ Add a new job to the main prometheus.conf file:
 ```
 
 ### for Prometheus v2
+
 Add a new job to the main prometheus.yml file:
 
 ```yaml
@@ -29,14 +30,17 @@ Add a new job to the main prometheus.yml file:
     scheme: "https"
 
     static_configs:
-    - targets: ['SERVER.LOCATION:PORT']
+    - targets: ["my.server.here:port"]
 ```
 
+An example of a Prometheus configuration with workers can be found in
+[metrics-howto.md](https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md).
+
 To use `synapse.rules` add
 
 ```yaml
-    rule_files:
-      - "/PATH/TO/synapse-v2.rules"
+  rule_files:
+    - "/PATH/TO/synapse-v2.rules"
 ```
 
 Metrics are disabled by default when running synapse; they must be enabled