Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit f49c209

Browse files
authored
Cross-link documentation to the prometheus recording rules. (#8667)
1 parent a699c04 commit f49c209

File tree

3 files changed

+4
-1
lines changed

3 files changed

+4
-1
lines changed

changelog.d/8667.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Interlink prometheus/grafana documentation.

contrib/grafana/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
0. Set up Prometheus and Grafana. Out of scope for this readme. Useful documentation about using Grafana with Prometheus: http://docs.grafana.org/features/datasources/prometheus/
44
1. Have your Prometheus scrape your Synapse. https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md
55
2. Import dashboard into Grafana. Download `synapse.json`. Import it to Grafana and select the correct Prometheus datasource. http://docs.grafana.org/reference/export_import/
6-
3. Set up additional recording rules
6+
3. Set up required recording rules. https://github.com/matrix-org/synapse/tree/master/contrib/prometheus

docs/metrics-howto.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@
6060

6161
1. Restart Prometheus.
6262

63+
1. Consider using the [grafana dashboard](https://github.com/matrix-org/synapse/tree/master/contrib/grafana/) and required [recording rules](https://github.com/matrix-org/synapse/tree/master/contrib/prometheus/)
64+
6365
## Monitoring workers
6466

6567
To monitor a Synapse installation using

0 commit comments

Comments
 (0)