Plugin: go.d.plugin Module: nvidia_smi
This collector monitors GPUs performance metrics using the nvidia-smi CLI tool.
Warning: under development, loop mode 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.
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 config directory.
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: update_every, autodetection_retry.
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 |
binary_path | Path 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_smi | no |
timeout | nvidia_smi binary execution timeout. | 2 | no |
use_csv_format | Used format when requesting GPU information. XML is used if set to ‘no’. | no | no |
Use CSV format when requesting GPU information.
jobs:
- name: nvidia_smi
use_csv_format: yes
The executable is not in the directories specified in the PATH environment variable.
jobs:
- name: nvidia_smi
binary_path: /usr/local/sbin/nvidia_smi
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 |
---|---|---|---|---|
nvidia_smi.gpu_pcie_bandwidth_usage | rx, tx | B/s | • | |
nvidia_smi.gpu_pcie_bandwidth_utilization | rx, tx | % | • | |
nvidia_smi.gpu_fan_speed_perc | fan_speed | % | • | • |
nvidia_smi.gpu_utilization | gpu | % | • | • |
nvidia_smi.gpu_memory_utilization | memory | % | • | • |
nvidia_smi.gpu_decoder_utilization | decoder | % | • | |
nvidia_smi.gpu_encoder_utilization | encoder | % | • | |
nvidia_smi.gpu_frame_buffer_memory_usage | free, used, reserved | B | • | • |
nvidia_smi.gpu_bar1_memory_usage | free, used | B | • | |
nvidia_smi.gpu_temperature | temperature | Celsius | • | • |
nvidia_smi.gpu_voltage | voltage | V | • | |
nvidia_smi.gpu_clock_freq | graphics, video, sm, mem | MHz | • | • |
nvidia_smi.gpu_power_draw | power_draw | Watts | • | • |
nvidia_smi.gpu_performance_state | P0-P15 | state | • | • |
nvidia_smi.gpu_mig_mode_current_status | enabled, disabled | status | • | |
nvidia_smi.gpu_mig_devices_count | mig | devices | • |
These metrics refer to the Multi-Instance GPU (MIG).
Labels:
Label | Description |
---|---|
uuid | GPU id (e.g. 00000000:00:04.0) |
product_name | GPU product name (e.g. NVIDIA A100-SXM4-40GB) |
gpu_instance_id | GPU instance id (e.g. 1) |
Metrics:
Metric | Dimensions | Unit | XML | CSV |
---|---|---|---|---|
nvidia_smi.gpu_mig_frame_buffer_memory_usage | free, used, reserved | B | • | |
nvidia_smi.gpu_mig_bar1_memory_usage | free, used | B | • |
There are no alerts configured by default for this integration.
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
If you’re encountering problems with the nvidia_smi
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 nvidia_smi
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.
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep nvidia_smi