synapse/contrib/prometheus/README.md

49 lines
1.1 KiB
Markdown
Raw Normal View History

This directory contains some sample monitoring config for using the
'Prometheus' monitoring server against synapse.
To use it, first install prometheus by following the instructions at
http://prometheus.io/
### for Prometheus v1
2019-01-30 18:32:33 +01:00
Add a new job to the main prometheus.conf file:
2019-01-30 18:32:33 +01:00
```yaml
job: {
name: "synapse"
target_group: {
target: "http://SERVER.LOCATION.HERE:PORT/_synapse/metrics"
}
}
2019-01-30 18:32:33 +01:00
```
### for Prometheus v2
Add a new job to the main prometheus.yml file:
2019-01-30 18:32:33 +01:00
```yaml
2017-11-07 13:35:35 +01:00
- job_name: "synapse"
metrics_path: "/_synapse/metrics"
# when endpoint uses https:
scheme: "https"
2017-11-07 13:35:35 +01:00
static_configs:
- targets: ["my.server.here:port"]
2019-01-30 18:32:33 +01:00
```
2017-11-07 13:35:35 +01:00
An example of a Prometheus configuration with workers can be found in
[metrics-howto.md](https://matrix-org.github.io/synapse/latest/metrics-howto.html).
2017-11-07 13:35:35 +01:00
To use `synapse.rules` add
2019-01-30 18:32:33 +01:00
```yaml
rule_files:
- "/PATH/TO/synapse-v2.rules"
2019-01-30 18:32:33 +01:00
```
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.