From 99e066ff5f05fd6b306bf852cf6a2d2f5f3bb228 Mon Sep 17 00:00:00 2001
From: Roland Pabel <pabel@uni-koeln.de>
Date: Fri, 17 Oct 2025 12:43:35 +0200
Subject: [PATCH] docu update for sudo

---
 collectors/gpfsMetric.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/collectors/gpfsMetric.md b/collectors/gpfsMetric.md
index aae04f2..aa5c8da 100644
--- a/collectors/gpfsMetric.md
+++ b/collectors/gpfsMetric.md
@@ -14,6 +14,7 @@ hugo_path: docs/reference/cc-metric-collector/collectors/gpfs.md
 ```json
   "gpfs": {
     "mmpmon_path": "/path/to/mmpmon",
+    "use_sudo": "true",
     "exclude_filesystem": [
       "fs1"
     ],
@@ -32,6 +33,11 @@ in the configuration.
 The path to the `mmpmon` command can be configured with the `mmpmon_path` option
 in the configuration. If nothing is set, the collector searches in `$PATH` for `mmpmon`.
 
+If cc-metric-collector is run as non-root, `sudo` can be enabled with `use_sudo`. 
+Because `mmpmon` is by default only executable as root, the Go procedure to
+search for it in `$PATH` will fail. If you use `sudo`, you must specify the
+complete path for `mmpmon` using the parameter `mmpmon_path`.
+
 
 Metrics:
 * `gpfs_bytes_read`