summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml')
-rw-r--r--src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml17
1 files changed, 7 insertions, 10 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml b/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml
index 71a5be2e7c..546f9c6c85 100644
--- a/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml
+++ b/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml
@@ -21,9 +21,10 @@ modules:
overview:
data_collection:
metrics_description: >
- This collector monitors the health of NVMe devices using the command line
- tool [nvme](https://github.com/linux-nvme/nvme-cli#nvme-cli), which can only be run by the root user. It uses `sudo` and
- assumes it is set up so that the netdata user can execute `nvme` as root without a password.
+ This collector monitors the health of NVMe devices.
+ It relies on the [`nvme`](https://github.com/linux-nvme/nvme-cli#nvme-cli) CLI tool but avoids directly executing the binary.
+ Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment.
+ This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.
method_description: ""
supported_platforms:
include: []
@@ -69,10 +70,6 @@ modules:
description: Recheck interval in seconds. Zero means no recheck will be scheduled.
default_value: 0
required: false
- - name: binary_path
- description: Path to nvme binary. The default is "nvme" and the executable is looked for in the directories specified in the PATH environment variable.
- default_value: nvme
- required: false
- name: timeout
description: nvme binary execution timeout.
default_value: 2
@@ -82,12 +79,12 @@ modules:
title: Config
enabled: true
list:
- - name: Custom binary path
- description: The executable is not in the directories specified in the PATH environment variable.
+ - name: Custom update_every
+ description: Allows you to override the default data collection interval.
config: |
jobs:
- name: nvme
- binary_path: /usr/local/sbin/nvme
+ update_every: 5 # Collect NVMe metrics every 5 seconds
troubleshooting:
problems:
list: []