Skip to main content

Nvidia GPU

Plugin: go.d.plugin Module: nvidia_smi

Overview

This collector monitors GPUs performance metrics using the nvidia-smi CLI tool.

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 gpu

These metrics refer to the GPU.

Labels:

LabelDescription
uuidGPU id (e.g. 00000000:00:04.0)
product_nameGPU product name (e.g. NVIDIA A100-SXM4-40GB)

Metrics:

MetricDimensionsUnit
nvidia_smi.gpu_pcie_bandwidth_usagerx, txB/s
nvidia_smi.gpu_pcie_bandwidth_utilizationrx, tx%
nvidia_smi.gpu_fan_speed_percfan_speed%
nvidia_smi.gpu_utilizationgpu%
nvidia_smi.gpu_memory_utilizationmemory%
nvidia_smi.gpu_decoder_utilizationdecoder%
nvidia_smi.gpu_encoder_utilizationencoder%
nvidia_smi.gpu_frame_buffer_memory_usagefree, used, reservedB
nvidia_smi.gpu_bar1_memory_usagefree, usedB
nvidia_smi.gpu_temperaturetemperatureCelsius
nvidia_smi.gpu_voltagevoltageV
nvidia_smi.gpu_clock_freqgraphics, video, sm, memMHz
nvidia_smi.gpu_power_drawpower_drawWatts
nvidia_smi.gpu_performance_stateP0-P15state
nvidia_smi.gpu_mig_mode_current_statusenabled, disabledstatus
nvidia_smi.gpu_mig_devices_countmigdevices

Per mig

These metrics refer to the Multi-Instance GPU (MIG).

Labels:

LabelDescription
uuidGPU id (e.g. 00000000:00:04.0)
product_nameGPU product name (e.g. NVIDIA A100-SXM4-40GB)
gpu_instance_idGPU instance id (e.g. 1)

Metrics:

MetricDimensionsUnit
nvidia_smi.gpu_mig_frame_buffer_memory_usagefree, used, reservedB
nvidia_smi.gpu_mig_bar1_memory_usagefree, usedB

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

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 config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/nvidia_smi.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
binary_pathPath to nvidia_smi binary. The default is "nvidia_smi" and the executable is looked for in the directories specified in the PATH environment variable.nvidia_smino
timeoutnvidia_smi binary execution timeout.2no
loop_modeWhen enabled, nvidia-smi is executed continuously in a separate thread using the -l option.yesno

Examples

Custom binary path

The executable is not in the directories specified in the PATH environment variable.

Config
jobs:
- name: nvidia_smi
binary_path: /usr/local/sbin/nvidia_smi

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

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].

    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 nvidia_smi

Getting Logs

If you're encountering problems with the nvidia_smi collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

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 nvidia_smi

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep nvidia_smi /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep nvidia_smi

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