grafana: include default dashboard and docs

pinheadmz · Aug 6, 2024 · 4fb03b1 · 4fb03b1
1 parent 6e47bad
commit 4fb03b1
Show file tree

Hide file tree

Showing 4 changed files with 124 additions and 0 deletions.
diff --git a/docs/compact_dashboard.png b/docs/compact_dashboard.png
diff --git a/docs/expanded_dashboard.png b/docs/expanded_dashboard.png
diff --git a/docs/monitoring.md b/docs/monitoring.md
@@ -79,5 +79,34 @@ resources/scripts/connect_logging.sh
 The Grafana dashboard (and API) will be accessible without requiring authentication
 at http://localhost:3000
 
+## Dashboards
 
+To view the default metrics in the included default dashboard, upload the dashboard
+JSON file to the Grafana server:
 
+```
+curl localhost:3000/api/dashboards/db \
+  -H "Content-Type: application/json" \
+  --data "{\"dashboard\": $(cat resources/configs/grafana/default_dashboard.json)}"
+```
+
+Note the URL in the reply from the server (example):
+
+```
+{"folderUid":"","id":2,"slug":"default-warnet-dashboard","status":"success","uid":"fdu0pda1z6a68b","url":"/d/fdu0pda1z6a68b/default-warnet-dashboard","version":1}(
+```
+
+Open the dashboard in your browser (example):
+
+`http://localhost:3000/d/fdu0pda1z6a68b/default-warnet-dashboard`
+
+The metrics visualizers in the default dashboard will appear with minimal size:
+
+
+![compact-dashboard](compact_dashboard.png)
+
+
+...but they can be stretched and rearranged by dragging in the browser:
+
+
+![compact-dashboard](expanded_dashboard.png)
diff --git a/resources/configs/grafana/default_dashboard.json b/resources/configs/grafana/default_dashboard.json
@@ -0,0 +1,95 @@
+{
+  "title": "Default Warnet Dashboard",
+  "refresh": "5s",
+  "panels":
+  [
+    {
+      "datasource":
+      {
+        "type": "prometheus",
+        "uid": "PBFA97CFB590B2093"
+      },
+      "targets":
+      [
+        {
+          "datasource":
+          {
+            "type": "prometheus",
+            "uid": "PBFA97CFB590B2093"
+          },
+          "expr": "outbounds",
+          "legendFormat": "{{pod}}",
+          "range": true
+        }
+      ],
+      "title": "Outbound connections",
+      "type": "timeseries"
+    },
+    {
+      "datasource":
+      {
+        "type": "prometheus",
+        "uid": "PBFA97CFB590B2093"
+      },
+      "targets":
+      [
+        {
+          "datasource":
+          {
+            "type": "prometheus",
+            "uid": "PBFA97CFB590B2093"
+          },
+          "expr": "inbounds",
+          "legendFormat": "{{pod}}",
+          "range": true
+        }
+      ],
+      "title": "Inbound connections",
+      "type": "timeseries"
+    },
+    {
+      "datasource":
+      {
+        "type": "prometheus",
+        "uid": "PBFA97CFB590B2093"
+      },
+      "targets":
+      [
+        {
+          "datasource":
+          {
+            "type": "prometheus",
+            "uid": "PBFA97CFB590B2093"
+          },
+          "expr": "mempool_size",
+          "legendFormat": "{{pod}}",
+          "range": true
+        }
+      ],
+      "title": "Mempool size",
+      "type": "timeseries"
+    },
+    {
+      "datasource":
+      {
+        "type": "prometheus",
+        "uid": "PBFA97CFB590B2093"
+      },
+      "targets":
+      [
+        {
+          "datasource":
+          {
+            "type": "prometheus",
+            "uid": "PBFA97CFB590B2093"
+          },
+          "expr": "blocks",
+          "legendFormat": "{{pod}}",
+          "range": true
+        }
+      ],
+      "title": "Blocks",
+      "type": "timeseries"
+    }
+  ]
+}