src/go/plugin/go.d/collector/nvme/README.md
Plugin: go.d.plugin Module: nvme
This collector monitors the health of NVMe devices. It relies on the nvme 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.
This collector is only supported on the following platforms:
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
This integration doesn't support auto-detection.
The default configuration for this integration does not impose any limits on data collection.
The default configuration for this integration is not expected to impose a significant performance impact on the system.
You can configure the nvme collector in two ways:
| Method | Best for | How to |
|---|---|---|
| UI | Fast setup without editing files | Go to Nodes → Configure this node → Collectors → Jobs, search for nvme, then click + to add a job. |
| File | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit go.d/nvme.conf and add a job. |
:::important
UI configuration requires paid Netdata Cloud plan.
:::
See Distro Support. Install nvme-cli using your distribution's package manager.
Your NVMe devices need to be accessible within the Docker container for Netdata to monitor them.
Include the following option in your docker run command or add the device mapping in your docker-compose.yml file:
docker run
--device '/dev/nvme0n1:/dev/nvme0n1'
docker-compose.yml
services:
netdata:
devices:
- "/dev/nvme0n1:/dev/nvme0n1"
Note: Replace /dev/nvme0n1 with your actual NVMe device name.
The following options can be defined globally: update_every, autodetection_retry.
<details open><summary>Config options</summary>| Option | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 10 | no |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
| timeout | nvme binary execution timeout. | 2 | no |
Configure the nvme collector from the Netdata web interface:
The configuration file name for this integration is go.d/nvme.conf.
The file format is YAML. Generally, the structure is:
update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/nvme.conf
Allows you to override the default data collection interval.
<details open><summary>Config</summary>jobs:
- name: nvme
update_every: 5 # Collect NVMe metrics every 5 seconds
The following alerts are available:
| Alert name | On metric | Description |
|---|---|---|
| nvme_device_critical_warnings_state | nvme.device_critical_warnings_state | NVMe device ${label:device} has critical warnings |
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
These metrics refer to the NVME device.
Labels:
| Label | Description |
|---|---|
| device | NVMe device name |
| model_number | NVMe device model |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nvme.device_estimated_endurance_perc | used | % |
| nvme.device_available_spare_perc | spare | % |
| nvme.device_composite_temperature | temperature | celsius |
| nvme.device_io_transferred_count | read, written | bytes |
| nvme.device_power_cycles_count | power | cycles |
| nvme.device_power_on_time | power-on | seconds |
| nvme.device_critical_warnings_state | available_spare, temp_threshold, nvm_subsystem_reliability, read_only, volatile_mem_backup_failed, persistent_memory_read_only | state |
| nvme.device_unsafe_shutdowns_count | unsafe | shutdowns |
| nvme.device_media_errors_rate | media | errors/s |
| nvme.device_error_log_entries_rate | error_log | entries/s |
| nvme.device_warning_composite_temperature_time | wctemp | seconds |
| nvme.device_critical_composite_temperature_time | cctemp | seconds |
| nvme.device_thermal_mgmt_temp1_transitions_rate | temp1 | transitions/s |
| nvme.device_thermal_mgmt_temp2_transitions_rate | temp2 | transitions/s |
| nvme.device_thermal_mgmt_temp1_time | temp1 | seconds |
| nvme.device_thermal_mgmt_temp2_time | temp2 | seconds |
Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
To troubleshoot issues with the nvme collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn't working.
Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on
your system, open netdata.conf and look for the plugins setting under [directories].
cd /usr/libexec/netdata/plugins.d/
Switch to the netdata user.
sudo -u netdata -s
Run the go.d.plugin to debug the collector:
./go.d.plugin -d -m nvme
To debug a specific job:
./go.d.plugin -d -m nvme -j jobName
If you're encountering problems with the nvme collector, follow these steps to retrieve logs and identify potential issues:
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep nvme
Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:
grep nvme /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
docker logs netdata 2>&1 | grep nvme