summary refs log tree commit diff
path: root/contrib/prometheus/README.md
blob: dc1927f2abf7607be01e103518315fe84bd67980 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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:

```yaml
  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:

```yaml
  - 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](https://element-hq.github.io/synapse/latest/metrics-howto.html).

To use `synapse.rules` add

```yaml
  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.