Skip to content

Commit

Permalink
cleanups for contrib/prometheus/README
Browse files Browse the repository at this point in the history
  • Loading branch information
richvdh committed Jan 30, 2019
1 parent b8b8986 commit a332116
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions contrib/prometheus/README → contrib/prometheus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,38 @@ 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: ['SERVER.LOCATION:PORT']
```
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
Expand Down

0 comments on commit a332116

Please sign in to comment.