synapse/contrib/grafana
Eric Eastwood 0b5f64ff09
Add Synapse version deploy annotations to Grafana dashboard (#15674)
Fix https://github.com/matrix-org/synapse/issues/15662

This manifests as purple lines that show up on all time series panels
that you can hover and see what version was deployed.

Also added a new "Deployed Synapse versions over time" panel
where the color block changes with each version. And mixed this
color block into the "Up" time series panel.

To get the Grafana dashboard JSON to copy here: use the **Share** icon at the top -> **Export** -> check the **Export for sharing externally** option -> **View JSON** or **Save to file**
2023-05-31 14:35:49 -05:00
..
README.md Fix some links in docs and contrib (#10370) 2021-07-13 11:55:48 +01:00
synapse.json Add Synapse version deploy annotations to Grafana dashboard (#15674) 2023-05-31 14:35:49 -05:00

Using the Synapse Grafana dashboard

  1. 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/
  2. Have your Prometheus scrape your Synapse. https://matrix-org.github.io/synapse/latest/metrics-howto.html
  3. Import dashboard into Grafana. Download synapse.json. Import it to Grafana and select the correct Prometheus datasource. http://docs.grafana.org/reference/export_import/
  4. Set up required recording rules. contrib/prometheus