0fed46ebe5
The official dashboard uses data from these rules, but they were never added to the synapse-v2.rules. They are mentioned in this issue: https://github.com/matrix-org/synapse/issues/7917#issuecomment-661330409, but never got added to the rules. Adding them results in all graphs in the "Event persist rate" section to function as intended. Signed-off-by: Johanna Dorothea Reichmann <transcaffeine@finallycoffee.eu> |
||
|---|---|---|
| .. | ||
| consoles | ||
| README.md | ||
| synapse-v1.rules | ||
| synapse-v2.rules | ||
README.md
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
for Prometheus v1
Add a new job to the main prometheus.conf file:
job: {
name: "synapse"
target_group: {
target: "http://SERVER.LOCATION.HERE:PORT/_synapse/metrics"
}
}
for Prometheus v2
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.