Add full setup instructions

tangle-network · Apr 13, 2023 · 0779de1 · 0779de1
1 parent b492097
commit 0779de1
Show file tree

Hide file tree

Showing 2 changed files with 150 additions and 1 deletion.
diff --git a/docker/grafana/README.md b/docker/grafana/README.md
@@ -4,5 +4,12 @@ Grafana Monitoring for relayer
 Use the following steps for monitoring:
 
 - Execute relayer on localhost as usual
+- Alternatively, change the target value from `localhost:9955` to the address of a remote relayer
 - Run `docker-compose up` in this directory
-- Visit `http://localhost:9090` (Prometheus) or `http://localhost:3000` (Grafana) in your browser
+- Open Prometheus on `http://localhost:9090`. You can directly query for data
+- Open Grafana on `http://localhost:3000`. Use the following steps for initial setup:
+    - Login with `admin` / `admin`
+    - Click the cogwheel icon on the bottom left and go to "Data sources"
+    - Click "Add new data source", and add Prometheus with URL `http://localhost:9090/`
+    - Click "Dashboard" in the top left menu and select "Import"
+    - Upload `grafana-dashboard.json` from this folder
diff --git a/docker/grafana/grafana-dashboard.json b/docker/grafana/grafana-dashboard.json
@@ -0,0 +1,142 @@
+{
+    "annotations": {
+      "list": [
+        {
+          "builtIn": 1,
+          "datasource": {
+            "type": "grafana",
+            "uid": "-- Grafana --"
+          },
+          "enable": true,
+          "hide": true,
+          "iconColor": "rgba(0, 211, 255, 1)",
+          "name": "Annotations & Alerts",
+          "target": {
+            "limit": 100,
+            "matchAny": false,
+            "tags": [],
+            "type": "dashboard"
+          },
+          "type": "dashboard"
+        }
+      ]
+    },
+    "editable": true,
+    "fiscalYearStartMonth": 0,
+    "graphTooltip": 0,
+    "id": 1,
+    "links": [],
+    "liveNow": false,
+    "panels": [
+      {
+        "datasource": {
+          "type": "prometheus",
+          "uid": "BtDYMgE4z"
+        },
+        "fieldConfig": {
+          "defaults": {
+            "color": {
+              "mode": "palette-classic"
+            },
+            "custom": {
+              "axisCenteredZero": false,
+              "axisColorMode": "text",
+              "axisLabel": "",
+              "axisPlacement": "auto",
+              "barAlignment": 0,
+              "drawStyle": "line",
+              "fillOpacity": 0,
+              "gradientMode": "none",
+              "hideFrom": {
+                "legend": false,
+                "tooltip": false,
+                "viz": false
+              },
+              "lineInterpolation": "linear",
+              "lineWidth": 1,
+              "pointSize": 5,
+              "scaleDistribution": {
+                "type": "linear"
+              },
+              "showPoints": "auto",
+              "spanNulls": false,
+              "stacking": {
+                "group": "A",
+                "mode": "none"
+              },
+              "thresholdsStyle": {
+                "mode": "off"
+              }
+            },
+            "mappings": [],
+            "thresholds": {
+              "mode": "absolute",
+              "steps": [
+                {
+                  "color": "green",
+                  "value": null
+                },
+                {
+                  "color": "red",
+                  "value": 80
+                }
+              ]
+            }
+          },
+          "overrides": []
+        },
+        "gridPos": {
+          "h": 8,
+          "w": 12,
+          "x": 0,
+          "y": 0
+        },
+        "id": 2,
+        "options": {
+          "legend": {
+            "calcs": [],
+            "displayMode": "list",
+            "placement": "bottom",
+            "showLegend": true
+          },
+          "tooltip": {
+            "mode": "single",
+            "sort": "none"
+          }
+        },
+        "targets": [
+          {
+            "datasource": {
+              "type": "prometheus",
+              "uid": "BtDYMgE4z"
+            },
+            "editorMode": "builder",
+            "expr": "bridge_watcher_back_off",
+            "legendFormat": "__auto",
+            "range": true,
+            "refId": "A"
+          }
+        ],
+        "title": "Panel Title",
+        "type": "timeseries"
+      }
+    ],
+    "refresh": "",
+    "revision": 1,
+    "schemaVersion": 38,
+    "style": "dark",
+    "tags": [],
+    "templating": {
+      "list": []
+    },
+    "time": {
+      "from": "now-6h",
+      "to": "now"
+    },
+    "timepicker": {},
+    "timezone": "",
+    "title": "Relayer",
+    "uid": "c3fyMgPVz",
+    "version": 2,
+    "weekStart": ""
+  }