Project: Netdata (Observability and Analysis / Observability)
File: nvme_devices.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/nvme/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/nvme/metadata.yaml" sidebar_label: "NVMe devices" learn_status: "Published" learnrelpath: "Collecting Metrics/Storage, Mount Points and Filesystems" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/nvme.svg" width="150"/> Plugin: go.d.plugin Module: nvme <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors the health of NVMe devices. It relies on the 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. 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. 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 | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nvme.deviceestimatedendurance_perc | used | % | | nvme.deviceavailablespare_perc | spare | % | | nvme.devicecompositetemperature | temperature | celsius | | nvme.deviceiotransferred_count | read, written | bytes | | nvme.devicepowercycles_count | power | cycles | | nvme.devicepoweron_time | power-on | seconds | | nvme.devicecriticalwarningsstate | availablespare, tempthreshold, nvmsubsystemreliability, readonly, volatilemembackupfailed, persistentmemoryreadonly | state | | nvme.deviceunsafeshutdowns_count | unsafe | shutdowns | | nvme.devicemediaerrors_rate | media | errors/s | | nvme.deviceerrorlogentriesrate | error_log | entries/s | | nvme.devicewarningcompositetemperaturetime | wctemp | seconds | | nvme.devicecriticalcompositetemperaturetime | cctemp | seconds | | nvme.devicethermalmgmttemp1transitions_rate | temp1 | transitions/s | | nvme.devicethermalmgmttemp2transitions_rate | temp2 | transitions/s | | nvme.devicethermalmgmttemp1time | temp1 | seconds | | nvme.devicethermalmgmttemp2time | temp2 | seconds | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | nvme.devicecriticalwarnings_state | NVMe device ${label:device} has critical warnings | See . Install `nvme-cli` using your distribution's package manager. 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 . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/nvme.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | 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 | </details> Allows you to override the default data collection interval. <details><summary>Config</summary> ```yaml jobs: name: nvme update_every: 5 # Collect NVMe metrics every 5 seconds ``` </details> 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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m nvme ```