From 781d49b9cd85b0504548d1366a0c9cb1d6707a37 Mon Sep 17 00:00:00 2001
From: Sam Feifer <sfeifer@redhat.com>
Date: Tue, 26 Nov 2024 10:48:50 -0500
Subject: [PATCH] Add configuration instructions to new dashboard

---
 CHANGELOG.md                                  |  8 ++++++++
 package.json                                  |  1 +
 .../pcp-vector-top-consumers.jsonnet          | 20 +++++++++++++++----
 yarn.lock                                     |  8 ++++----
 4 files changed, 29 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1b98d7e2..1fdd76ae 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,8 +1,16 @@
 # Change Log
 
+## 5.2.2 (2024-11-26)
+
+* **dashboards**: add configuration instructions to PCP Vector Top Consumers dashboard
+* **build**: update node dependencies
+
+
 ## 5.2.1 (2024-11-12)
+
 * **build**: update Go and node dependencies
 
+
 ## 5.2.0 (2024-11-08)
 
 * **valkey**: new PCP Valkey datasource (replacement for PCP Redis)
diff --git a/package.json b/package.json
index dd46cd25..7acbf3d9 100644
--- a/package.json
+++ b/package.json
@@ -64,6 +64,7 @@
     "redux-thunk": "^2.3.0"
   },
   "resolutions": {
+    "cross-spawn": "^7.0.5",
     "moment": "^2.29.4",
     "moment-timezone": "^0.5.35",
     "d3-color": "^3.1.0",
diff --git a/src/datasources/vector/dashboards/pcp-vector-top-consumers.jsonnet b/src/datasources/vector/dashboards/pcp-vector-top-consumers.jsonnet
index d33bd6ed..cef1a0e5 100644
--- a/src/datasources/vector/dashboards/pcp-vector-top-consumers.jsonnet
+++ b/src/datasources/vector/dashboards/pcp-vector-top-consumers.jsonnet
@@ -14,6 +14,18 @@ grafana.dashboard.new(
     'PCP Vector',
   )
 )
+.addPanel(
+  grafana.text.new(
+    'Configuration Instructions',
+    mode='markdown',
+    content='This dashboard requires [authentication](https://grafana-pcp.readthedocs.io/en/latest/datasources/authentication.html) to be set up for the PCP Vector datasource. The "Top Network Consumers" table requires the [bcc PMDA](https://man7.org/linux/man-pages/man1/pmdabcc.1.html) to be installed and configured with the netproc module.',
+  ), gridPos={
+    x: 0,
+    y: 0,
+    w: 24,
+    h: 2,
+  }
+)
 .addPanel(
     grafana.tablePanel.new(
         'Top CPU consumers',
@@ -24,7 +36,7 @@ grafana.dashboard.new(
         { expr: 'proc.hog.cpu', format: 'metrics_table', legendFormat: '$metric' },
     ])  + { options+: {sortBy: [{desc: true, displayName: 'proc.hog.cpu'}]}}, gridPos={
         x: 0,
-        y: 0,
+        y: 2,
         w: 12,
         h: 8,
     }
@@ -39,7 +51,7 @@ grafana.dashboard.new(
         { expr: 'proc.hog.mem', format: 'metrics_table', legendFormat: '$metric' },
     ]) + { options+: {sortBy: [{desc: true, displayName: 'proc.hog.mem'}]}}, gridPos={
         x: 12,
-        y: 0,
+        y: 2,
         w: 12,
         h: 8,
     }
@@ -54,7 +66,7 @@ grafana.dashboard.new(
         { expr: 'proc.hog.disk', format: 'metrics_table', legendFormat: '$metric' },
     ]) + { options+: {sortBy: [{desc: true, displayName: 'proc.hog.disk'}]}}, gridPos={
         x: 0,
-        y: 8,
+        y: 10,
         w: 12,
         h: 8,
     }
@@ -69,7 +81,7 @@ grafana.dashboard.new(
         { expr: 'proc.hog.net', format: 'metrics_table', legendFormat: '$metric' },
     ]) + { options+: {sortBy: [{desc: true, displayName: 'proc.hog.net'}]}}, gridPos={
         x: 12,
-        y: 8,
+        y: 10,
         w: 12,
         h: 8,
     }
diff --git a/yarn.lock b/yarn.lock
index 87f346cb..757627a5 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -4998,10 +4998,10 @@ create-require@^1.1.0:
   resolved "https://registry.yarnpkg.com/create-require/-/create-require-1.1.1.tgz#c1d7e8f1e5f6cfc9ff65f9cd352d37348756c333"
   integrity sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==
 
-cross-spawn@^7.0.0, cross-spawn@^7.0.2, cross-spawn@^7.0.3:
-  version "7.0.3"
-  resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6"
-  integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==
+cross-spawn@^7.0.0, cross-spawn@^7.0.2, cross-spawn@^7.0.3, cross-spawn@^7.0.5:
+  version "7.0.6"
+  resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f"
+  integrity sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==
   dependencies:
     path-key "^3.1.0"
     shebang-command "^2.0.0"