Mirrors
/
synapse-old
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cleanups for contrib/prometheus/README

This commit is contained in:
Richard van der Hoff 2019-01-30 17:32:33 +00:00
parent b8b898666e
commit a332116276
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
contrib/prometheus/README → contrib/prometheus/README.md
View File

@ -6,8 +6,10 @@ To use it, first install prometheus by following the instructions at
http://prometheus.io/ http://prometheus.io/
### for Prometheus v1 ### for Prometheus v1
Add a new job to the main prometheus.conf file: Add a new job to the main prometheus.conf file:
```yaml
job: { job: {
name: "synapse" name: "synapse"
@ -15,10 +17,12 @@ Add a new job to the main prometheus.conf file:
target: "http://SERVER.LOCATION.HERE:PORT/_synapse/metrics" target: "http://SERVER.LOCATION.HERE:PORT/_synapse/metrics"
} }
} }
```
### for Prometheus v2 ### for Prometheus v2
Add a new job to the main prometheus.yml file: Add a new job to the main prometheus.yml file:
```yaml
- job_name: "synapse" - job_name: "synapse"
metrics_path: "/_synapse/metrics" metrics_path: "/_synapse/metrics"
# when endpoint uses https: # when endpoint uses https:
@ -26,11 +30,14 @@ Add a new job to the main prometheus.yml file:
static_configs: static_configs:
- targets: ['SERVER.LOCATION:PORT'] - targets: ['SERVER.LOCATION:PORT']
```
To use `synapse.rules` add To use `synapse.rules` add
```yaml
rule_files: rule_files:
- "/PATH/TO/synapse-v2.rules" - "/PATH/TO/synapse-v2.rules"
```
Metrics are disabled by default when running synapse; they must be enabled 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 with the 'enable-metrics' option, either in the synapse config file or as a