Fix #34712: add descriptions to dashboards

Author: LEDfan

overlays/monitoring/components/container-sharing/configs/dashboards/shinyproxy-delegate-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 delegate apps. This are the containers used by apps using pre-initialization or container-sharing.\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 at which the delegate app was (automatically) launched. Only shown if a single id is selected. ",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -61,7 +112,7 @@
         "h": 2,
         "w": 4,
         "x": 0,
-        "y": 0
+        "y": 9
       },
       "id": 4,
       "options": {
@@ -83,6 +134,7 @@
         "wideLayout": true
       },
       "pluginVersion": "8.5.6",
+      "maxDataPoints": 10000,
       "targets": [
         {
           "datasource": {
@@ -119,7 +171,7 @@
         "type": "prometheus",
         "uid": "${prometheus}"
       },
-      "description": "",
+      "description": "The id of the application spec. Only shown if a single id is selected.",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -148,7 +200,7 @@
         "h": 2,
         "w": 4,
         "x": 4,
-        "y": 0
+        "y": 9
       },
       "id": 6,
       "options": {
@@ -207,7 +259,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. \n",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -250,7 +302,7 @@
         "h": 2,
         "w": 4,
         "x": 8,
-        "y": 0
+        "y": 9
       },
       "id": 5,
       "options": {
@@ -296,6 +348,7 @@
         "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": []
@@ -304,7 +357,7 @@
         "h": 27,
         "w": 24,
         "x": 0,
-        "y": 2
+        "y": 11
       },
       "id": 2,
       "options": {

overlays/monitoring/components/container-sharing/configs/dashboards/shinyproxy-delegate-app-resources.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 resources (CPU and memory) consumed by delegate apps.  This are the containers used by apps using pre-initialization or container-sharing.\n\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- select a single id to view the exact values \n- some panels might be empty when an app fails to startup or crashes shortly (1-2 minutes) after startup",
+        "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": "${datasource}"
       },
-      "description": "",
+      "description": "The time at which the delegate app was (automatically) launched. 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": {
@@ -119,7 +170,7 @@
         "type": "prometheus",
         "uid": "${datasource}"
       },
-      "description": "",
+      "description": "The id of the application spec. Only shown if a single id is selected.",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -148,7 +199,7 @@
         "h": 2,
         "w": 4,
         "x": 4,
-        "y": 0
+        "y": 9
       },
       "id": 13,
       "options": {
@@ -207,7 +258,7 @@
         "type": "prometheus",
         "uid": "${datasource}"
       },
-      "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. \n",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -250,7 +301,7 @@
         "h": 2,
         "w": 4,
         "x": 8,
-        "y": 0
+        "y": 9
       },
       "id": 5,
       "options": {
@@ -296,6 +347,7 @@
         "type": "prometheus",
         "uid": "${datasource}"
       },
+      "description": "The CPU usage of an app. The requests and limits are summed for all instances. Select a single id to view the exact requests and limits for an app.",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -418,7 +470,7 @@
         "h": 6,
         "w": 24,
         "x": 0,
-        "y": 2
+        "y": 11
       },
       "id": 6,
       "interval": "1m",
@@ -487,6 +539,7 @@
         "type": "prometheus",
         "uid": "${datasource}"
       },
+      "description": "The CPU throttling of an app. An app is throttled when it tries to user more CPU resources than allowed by the `container-cpu-limit` setting. If no `container-cpu-limit` is configured, the panel will show the text `No data`.",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -549,7 +602,7 @@
         "h": 5,
         "w": 24,
         "x": 0,
-        "y": 8
+        "y": 17
       },
       "id": 8,
       "interval": "1m",
@@ -593,6 +646,7 @@
         "type": "prometheus",
         "uid": "${datasource}"
       },
+      "description": "The memory usage of an app. The requests and limits are summed for all instances. Select a single id to view the exact requests and limits for an app.",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -735,7 +789,7 @@
         "h": 6,
         "w": 24,
         "x": 0,
-        "y": 13
+        "y": 22
       },
       "id": 12,
       "interval": "1m",
@@ -808,6 +862,7 @@
         "type": "prometheus",
         "uid": "${datasource}"
       },
+      "description": "",
       "fieldConfig": {
         "defaults": {
           "color": {
@@ -899,7 +954,7 @@
         "h": 6,
         "w": 24,
         "x": 0,
-        "y": 19
+        "y": 28
       },
       "id": 10,
       "options": {