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

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/nvidia_smi/README.md" metayaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/nvidiasmi/metadata.yaml" sidebar_label: "Nvidia GPU" learn_status: "Published" learnrelpath: "Collecting Metrics/Hardware Devices and Sensors" 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/nvidia.svg" width="150"/> Plugin: go.d.plugin Module: nvidia_smi <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors GPUs performance metrics using the CLI tool. Warning: under development, not implemented yet. 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 GPU. Labels: | Label | Description | |:--|:-| | uuid | GPU id (e.g. 00000000:00:04.0) | | product_name | GPU product name (e.g. NVIDIA A100-SXM4-40GB) | Metrics: | Metric | Dimensions | Unit | XML | CSV | |:|:-|:-|::|::| | nvidiasmi.gpupciebandwidthusage | rx, tx | B/s | | | | nvidiasmi.gpupciebandwidthutilization | rx, tx | % | | | | nvidiasmi.gpufanspeedperc | fan_speed | % | | | | nvidiasmi.gpuutilization | gpu | % | | | | nvidiasmi.gpumemory_utilization | memory | % | | | | nvidiasmi.gpudecoder_utilization | decoder | % | | | | nvidiasmi.gpuencoder_utilization | encoder | % | | | | nvidiasmi.gpuframebuffermemory_usage | free, used, reserved | B | | | | nvidiasmi.gpubar1memoryusage | free, used | B | | | | nvidiasmi.gputemperature | temperature | Celsius | | | | nvidiasmi.gpuvoltage | voltage | V | | | | nvidiasmi.gpuclock_freq | graphics, video, sm, mem | MHz | | | | nvidiasmi.gpupowerdraw | powerdraw | Watts | | | | nvidiasmi.gpuperformance_state | P0-P15 | state | | | | nvidiasmi.gpumigmodecurrent_status | enabled, disabled | status | | | | nvidiasmi.gpumigdevicescount | mig | devices | | | These metrics refer to the Multi-Instance GPU

Labels: | Label | Description | |:--|:-| | uuid | GPU id (e.g. 00000000:00:04.0) | | product_name | GPU product name (e.g. NVIDIA A100-SXM4-40GB) | | gpuinstanceid | GPU instance id (e.g. 1) | Metrics: | Metric | Dimensions | Unit | XML | CSV | |:|:-|:-|::|::| | nvidiasmi.gpumigframebuffermemoryusage | free, used, reserved | B | | | | nvidiasmi.gpumigbar1memory_usage | free, used | B | | | There are no alerts configured by default for this integration. This collector is disabled by default. You need to explicitly enable it in the `go.d.conf` file. The configuration file name for this integration is `go.d/nvidia_smi.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/nvidia_smi.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 | | binarypath | Path to nvidiasmi binary. The default is "nvidiasmi" and the executable is looked for in the directories specified in the PATH environment variable. | nvidiasmi | no | | timeout | nvidia_smi binary execution timeout. | 2 | no | | usecsvformat | Used format when requesting GPU information. XML is used if set to 'no'. | no | no | </details> Use CSV format when requesting GPU information. <details><summary>Config</summary> ```yaml jobs: name: nvidia_smi usecsvformat: yes ``` </details> The executable is not in the directories specified in the PATH environment variable. <details><summary>Config</summary> ```yaml jobs: name: nvidia_smi binarypath: /usr/local/sbin/nvidiasmi ``` </details> To troubleshoot issues with the `nvidia_smi` 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 nvidia_smi ```