reivilibre ac7e5683d6 Add comments to the Prometheus recording rules to make it clear which set of rules you need for Grafana or Prometheus Console. (#13876) | 2 years ago | |
---|---|---|
.. | ||
consoles | 6a78ede569 Improve `reactor_tick_time` metric (#11724) | 2 years ago |
README.md | e938f69697 Fix some links in `docs` and `contrib` (#10370) | 3 years ago |
synapse-v2.rules | ac7e5683d6 Add comments to the Prometheus recording rules to make it clear which set of rules you need for Grafana or Prometheus Console. (#13876) | 2 years ago |
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
Add a new job to the main prometheus.conf file:
job: {
name: "synapse"
target_group: {
target: "http://SERVER.LOCATION.HERE:PORT/_synapse/metrics"
}
}
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: ["my.server.here:port"]
An example of a Prometheus configuration with workers can be found in metrics-howto.md.
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.