Fix #34712: add descriptions to dashboards

Author: LEDfan

src/main/resources/configs/docker/monitoring/grafana/dashboards/shinyproxy-aggregated-usage.json

@@ -26,11 +26,63 @@
   "graphTooltip": 0,
   "links": [],
   "panels": [
+    {
+      "collapsed": false,
+      "gridPos": {
+        "h": 1,
+        "w": 24,
+        "x": 0,
+        "y": 0
+      },
+      "id": 7,
+      "panels": [],
+      "title": "Description",
+      "type": "row"
+    },
+    {
+      "fieldConfig": {
+        "defaults": {},
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 5,
+        "w": 24,
+        "x": 0,
+        "y": 1
+      },
+      "id": 5,
+      "options": {
+        "code": {
+          "language": "plaintext",
+          "showLineNumbers": false,
+          "showMiniMap": false
+        },
+        "content": "This dashboard shows the aggregated usage of ShinyProxy.\n\n**Tips:**\n\n- use the filters on the top of page\n- change the time range in the top-right corner of the page\n- disable the automatic refresh (in the top-right corner) if the dashboard takes a long time to load",
+        "mode": "markdown"
+      },
+      "pluginVersion": "11.6.1",
+      "title": "",
+      "type": "text"
+    },
+    {
+      "collapsed": false,
+      "gridPos": {
+        "h": 1,
+        "w": 24,
+        "x": 0,
+        "y": 6
+      },
+      "id": 6,
+      "panels": [],
+      "title": "",
+      "type": "row"
+    },
     {
       "datasource": {
         "type": "prometheus",
         "uid": "${datasource}"
       },
+      "description": "The number of times an app has been started. Does not include currently running apps (only apps that haven been stopped).",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -65,7 +117,7 @@
         "h": 9,
         "w": 24,
         "x": 0,
-        "y": 0
+        "y": 7
       },
       "id": 2,
       "options": {
@@ -152,6 +204,7 @@
         "type": "prometheus",
         "uid": "${datasource}"
       },
+      "description": "The total time an app has been running. Combines all instances of an app of all users. Does not include currently running apps (only apps that haven been stopped).",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -187,7 +240,7 @@
         "h": 9,
         "w": 24,
         "x": 0,
-        "y": 9
+        "y": 16
       },
       "id": 3,
       "options": {
@@ -272,6 +325,7 @@
         "type": "prometheus",
         "uid": "${datasource}"
       },
+      "description": "The average time an app instance runs. This is the average of all instances of an app of all users. Does not include currently running apps (only apps that haven been stopped).",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -307,7 +361,7 @@
         "h": 9,
         "w": 24,
         "x": 0,
-        "y": 18
+        "y": 25
       },
       "id": 4,
       "options": {

src/main/resources/configs/docker/monitoring/grafana/dashboards/shinyproxy-app-logs.json

@@ -27,12 +27,63 @@
   "graphTooltip": 0,
   "links": [],
   "panels": [
+    {
+      "collapsed": false,
+      "gridPos": {
+        "h": 1,
+        "w": 24,
+        "x": 0,
+        "y": 0
+      },
+      "id": 11,
+      "panels": [],
+      "title": "Description",
+      "type": "row"
+    },
+    {
+      "fieldConfig": {
+        "defaults": {},
+        "overrides": []
+      },
+      "gridPos": {
+        "h": 7,
+        "w": 24,
+        "x": 0,
+        "y": 1
+      },
+      "id": 12,
+      "options": {
+        "code": {
+          "language": "plaintext",
+          "showLineNumbers": false,
+          "showMiniMap": false
+        },
+        "content": "This dashboard shows the logs of apps.\n\n**Tips:**\n\n- use the filters on the top of page\n- the app metadata is only shown when a single id is selected\n- change the time range in the top-right corner of the page\n- disable the automatic refresh (in the top-right corner) if the dashboard takes a long time to load\n- when the time range exceeds 7 days, the dashboard might fail to load the data\n- use the calendar button (in the time range selector) to load data on specific dates or times\n- click on a log line to see the app id and other metadata",
+        "mode": "markdown"
+      },
+      "pluginVersion": "11.6.1",
+      "title": "",
+      "type": "text"
+    },
+    {
+      "collapsed": false,
+      "gridPos": {
+        "h": 1,
+        "w": 24,
+        "x": 0,
+        "y": 8
+      },
+      "id": 10,
+      "panels": [],
+      "title": "",
+      "type": "row"
+    },
     {
       "datasource": {
         "type": "prometheus",
         "uid": "${prometheus}"
       },
-      "description": "",
+      "description": "The time the user launched the application. Only shown if a single id is selected. ",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -60,7 +111,7 @@
         "h": 2,
         "w": 4,
         "x": 0,
-        "y": 0
+        "y": 9
       },
       "id": 4,
       "options": {
@@ -116,7 +167,7 @@
         "type": "prometheus",
         "uid": "${prometheus}"
       },
-      "description": "",
+      "description": "The name of the user that launched the app. Only shown if a single id is selected. ",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -144,7 +195,7 @@
         "h": 2,
         "w": 4,
         "x": 4,
-        "y": 0
+        "y": 9
       },
       "id": 6,
       "options": {
@@ -206,7 +257,7 @@
         "type": "prometheus",
         "uid": "${prometheus}"
       },
-      "description": "",
+      "description": "The id of the application spec. Only shown if a single id is selected. ",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -234,7 +285,7 @@
         "h": 2,
         "w": 4,
         "x": 8,
-        "y": 0
+        "y": 9
       },
       "id": 7,
       "options": {
@@ -296,7 +347,7 @@
         "type": "prometheus",
         "uid": "${prometheus}"
       },
-      "description": "",
+      "description": "The name of the instance. By default this is `_`. When a user can start multiple instances of the same app, this is the name chosen by the user. Only shown if a single id is selected. ",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -324,7 +375,7 @@
         "h": 2,
         "w": 4,
         "x": 12,
-        "y": 0
+        "y": 9
       },
       "id": 8,
       "options": {
@@ -386,7 +437,7 @@
         "type": "prometheus",
         "uid": "${prometheus}"
       },
-      "description": "",
+      "description": "The status of the app. It can take up to two minutes for the status to change. Only shown if a single id is selected. ",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -445,7 +496,7 @@
         "h": 2,
         "w": 4,
         "x": 16,
-        "y": 0
+        "y": 9
       },
       "id": 5,
       "options": {
@@ -489,11 +540,16 @@
         "type": "loki",
         "uid": "${datasource}"
       },
+      "description": "The logs related to the application. Log lines containing `[ShinyProxy]` are generated by ShinyProxy. Log lines containing `[App]` are generated by the app container.",
+      "fieldConfig": {
+        "defaults": {},
+        "overrides": []
+      },
       "gridPos": {
         "h": 27,
         "w": 24,
         "x": 0,
-        "y": 2
+        "y": 11
       },
       "id": 2,
       "options": {