Skip to main content

NVMe devices

Plugin: go.d.plugin Module: nvme

Overview

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 supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per device

These metrics refer to the NVME device.

Labels:

LabelDescription
deviceNVMe device name

Metrics:

MetricDimensionsUnit
nvme.device_estimated_endurance_percused%
nvme.device_available_spare_percspare%
nvme.device_composite_temperaturetemperaturecelsius
nvme.device_io_transferred_countread, writtenbytes
nvme.device_power_cycles_countpowercycles
nvme.device_power_on_timepower-onseconds
nvme.device_critical_warnings_stateavailable_spare, temp_threshold, nvm_subsystem_reliability, read_only, volatile_mem_backup_failed, persistent_memory_read_onlystate
nvme.device_unsafe_shutdowns_countunsafeshutdowns
nvme.device_media_errors_ratemediaerrors/s
nvme.device_error_log_entries_rateerror_logentries/s
nvme.device_warning_composite_temperature_timewctempseconds
nvme.device_critical_composite_temperature_timecctempseconds
nvme.device_thermal_mgmt_temp1_transitions_ratetemp1transitions/s
nvme.device_thermal_mgmt_temp2_transitions_ratetemp2transitions/s
nvme.device_thermal_mgmt_temp1_timetemp1seconds
nvme.device_thermal_mgmt_temp2_timetemp2seconds

Alerts

The following alerts are available:

Alert nameOn metricDescription
nvme_device_critical_warnings_state nvme.device_critical_warnings_stateNVMe device ${label:device} has critical warnings

Setup

Prerequisites

Install nvme-cli

See Distro Support. Install nvme-cli using your distribution's package manager.

For Netdata running in a Docker container: grant NVMe device access

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.

Configuration

File

The configuration file name for this integration is go.d/nvme.conf.

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

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.10no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
timeoutnvme binary execution timeout.2no

Examples

Custom update_every

Allows you to override the default data collection interval.

Config
jobs:
- name: nvme
update_every: 5 # Collect NVMe metrics every 5 seconds

Troubleshooting

Debug Mode

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

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.