diff options
| author | Michael Kaye <1917473+michaelkaye@users.noreply.github.com> | 2020-10-27 19:29:50 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-27 15:29:50 -0400 |
| commit | f49c2093b5da35d77cae5c40140d330d4c42ef48 (patch) | |
| tree | 06538be81041e457e5461ccffa31db70988dbfeb | |
| parent | Abstract code for stripping room state into a separate method (#8671) (diff) | |
| download | synapse-f49c2093b5da35d77cae5c40140d330d4c42ef48.tar.xz | |
Cross-link documentation to the prometheus recording rules. (#8667)
| -rw-r--r-- | changelog.d/8667.doc | 1 | ||||
| -rw-r--r-- | contrib/grafana/README.md | 2 | ||||
| -rw-r--r-- | docs/metrics-howto.md | 2 |
3 files changed, 4 insertions, 1 deletions
diff --git a/changelog.d/8667.doc b/changelog.d/8667.doc new file mode 100644 index 0000000000..422d697da6 --- /dev/null +++ b/changelog.d/8667.doc @@ -0,0 +1 @@ +Interlink prometheus/grafana documentation. diff --git a/contrib/grafana/README.md b/contrib/grafana/README.md index ca780d412e..4608793394 100644 --- a/contrib/grafana/README.md +++ b/contrib/grafana/README.md @@ -3,4 +3,4 @@ 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/ 1. Have your Prometheus scrape your Synapse. https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md 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/ -3. Set up additional recording rules +3. Set up required recording rules. https://github.com/matrix-org/synapse/tree/master/contrib/prometheus diff --git a/docs/metrics-howto.md b/docs/metrics-howto.md index b386ec91c1..fb71af4911 100644 --- a/docs/metrics-howto.md +++ b/docs/metrics-howto.md @@ -60,6 +60,8 @@ 1. Restart Prometheus. +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/) + ## Monitoring workers To monitor a Synapse installation using |