summary refs log tree commit diff
diff options
context:
space:
mode:
authorPaul Tötterman <ptman@users.noreply.github.com>2018-07-31 12:48:37 +0300
committerGitHub <noreply@github.com>2018-07-31 12:48:37 +0300
commit9c14c2b5610956f4daa4c472929ccaa2b6b6ae22 (patch)
treeb9077805ce09d0ac60c5cfaef7966a34fabcbd17
parentsynapse grafana dashboard (diff)
downloadsynapse-9c14c2b5610956f4daa4c472929ccaa2b6b6ae22.tar.xz
Add some documentation for using the dashboard
-rw-r--r--contrib/grafana/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/contrib/grafana/README.md b/contrib/grafana/README.md
new file mode 100644
index 0000000000..6a6cc0bed4
--- /dev/null
+++ b/contrib/grafana/README.md
@@ -0,0 +1,6 @@
+# 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.rst
+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