diff options
author | Richard van der Hoff <richard@matrix.org> | 2019-01-30 17:32:33 +0000 |
---|---|---|
committer | Richard van der Hoff <richard@matrix.org> | 2019-01-30 17:32:33 +0000 |
commit | a3321162766a77d9a14530954f0b4294beb743bd (patch) | |
tree | ea786483861b3d1a2d395f4c3e8c90ca7035a97d | |
parent | v0.99.0rc2 (diff) | |
download | synapse-a3321162766a77d9a14530954f0b4294beb743bd.tar.xz |
cleanups for contrib/prometheus/README
-rw-r--r-- | contrib/prometheus/README.md (renamed from contrib/prometheus/README) | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/contrib/prometheus/README b/contrib/prometheus/README.md index 7b733172e6..e646cb7ea7 100644 --- a/contrib/prometheus/README +++ b/contrib/prometheus/README.md @@ -6,8 +6,10 @@ To use it, first install prometheus by following the instructions at http://prometheus.io/ ### for Prometheus v1 + Add a new job to the main prometheus.conf file: +```yaml job: { name: "synapse" @@ -15,10 +17,12 @@ Add a new job to the main prometheus.conf file: target: "http://SERVER.LOCATION.HERE:PORT/_synapse/metrics" } } +``` ### for Prometheus v2 Add a new job to the main prometheus.yml file: +```yaml - job_name: "synapse" metrics_path: "/_synapse/metrics" # when endpoint uses https: @@ -26,11 +30,14 @@ Add a new job to the main prometheus.yml file: static_configs: - targets: ['SERVER.LOCATION:PORT'] +``` To use `synapse.rules` add +```yaml 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 |