feat(grafana): use Python script to generate dashboard (#2979)

Signed-off-by: Alex Chi <[email protected]>
risingwavelabs · Jun 6, 2022 · 485874d · 485874d
1 parent 2a3e88a
commit 485874d
Show file tree

Hide file tree

Showing 9 changed files with 1,139 additions and 8,911 deletions.
diff --git a/docker/risingwave-dashboard.json b/docker/risingwave-dashboard.json
diff --git a/docker/risingwave.toml b/docker/risingwave.toml
@@ -13,4 +13,4 @@ block_size_kb = 64
 bloom_false_positive = 0.01
 data_directory = "hummock_001"
 block_cache_capacity_mb = 4096
-meta_cache_capacity_mb = 256
+meta_cache_capacity_mb = 1024
diff --git a/docs/developer-guide.md b/docs/developer-guide.md
@@ -316,18 +316,7 @@ buf lint
 
 ## Update Grafana dashboard
 
-Simply use the export functionality in Grafana, disable the config "external sharing". Then,
-manually modify the JSON.
-
-All datasource should use `risedev-prometheus` as datasource. If you found something else,
-change them.
-
-```
-"datasource": {
-  "type": "prometheus",
-  "uid": "risedev-prometheus"
-},
-```
+See [README](../grafana/README.md) for more information.
 
 ## Add new files
 

diff --git a/grafana/.gitignore b/grafana/.gitignore
@@ -0,0 +1,3 @@
+venv
+*.gen.json
+__pycache__
diff --git a/grafana/README.md b/grafana/README.md
@@ -0,0 +1,22 @@
+# RisingWave Grafana Dashboard
+
+The Grafana dashboard is generated with grafanalib. You'll need Python and
+
+```
+pip3 install grafanalib
+brew install jq
+```
+
+... preferably installed in a local venv.
+
+## Generate Dashboard
+
+```
+./generate.sh
+```
+
+## Update without Restarting Grafana
+
+```
+./update.sh
+```
diff --git a/grafana/generate.sh b/grafana/generate.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -euo pipefail
+
+generate-dashboard -o risingwave-dashboard.gen.json risingwave-dashboard.py
+jq -c . risingwave-dashboard.gen.json > risingwave-dashboard.json