synapse/contrib/grafana/README.md

# Using the Synapse Grafana dashboard

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 required recording rules. https://github.com/matrix-org/synapse/tree/master/contrib/prometheus
Add some documentation for using the dashboard 2018-07-31 03:48:37 -06:00			`# Using the Synapse Grafana dashboard`

			`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/`
rst->md 2020-03-01 14:21:36 -07:00			`1. Have your Prometheus scrape your Synapse. https://github.com/matrix-org/synapse/blob/master/docs/metrics-howto.md`
Add some documentation for using the dashboard 2018-07-31 03:48:37 -06:00			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/
Cross-link documentation to the prometheus recording rules. (#8667) 2020-10-27 13:29:50 -06:00			`3. Set up required recording rules. https://github.com/matrix-org/synapse/tree/master/contrib/prometheus`