forked-synapse

mirror of https://mau.dev/maunium/synapse.git synced 2024-10-01 01:36:05 -04:00

History

Krombel c161472575 Make clear that the config has changed since prometheus v2 This restores the config that is usable for prometheus pre v2.0.0 The new config only works for Prometheus v2+		2017-11-14 19:59:26 +01:00
..
consoles	Add prometheus config	2017-08-16 15:31:44 +01:00
README	Make clear that the config has changed since prometheus v2	2017-11-14 19:59:26 +01:00
synapse-v1.rules	Make clear that the config has changed since prometheus v2	2017-11-14 19:59:26 +01:00
synapse-v2.rules	Make clear that the config has changed since prometheus v2	2017-11-14 19:59:26 +01:00

README

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.