0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-15 03:03:50 +01:00
synapse/contrib/prometheus
2019-01-30 17:32:33 +00:00
..
consoles make prometheus config compliant to v0.28 2018-04-05 23:34:01 +02:00
README.md cleanups for contrib/prometheus/README 2019-01-30 17:32:33 +00:00
synapse-v1.rules make prometheus config compliant to v0.28 2018-04-05 23:34:01 +02:00
synapse-v2.rules make prometheus config compliant to v0.28 2018-04-05 23:34:01 +02:00

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

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: ['SERVER.LOCATION:PORT']

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.