nvidia_smi

package

v0.51.3 Latest Latest Go to latest Published: Mar 16, 2023 License: GPL-3.0 Imports: 17 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/netdata/go.d.plugin

Links

Open Source Insights

README ¶

Nvidia GPU collector

Monitors performance metrics (memory usage, fan speed, pcie bandwidth utilization, temperature, etc.) using the nvidia-smi CLI tool.

Warning: under development, collects fewer metrics then python version.

Metrics

All metrics have "nvidia_smi." prefix.

Labels per scope:

gpu: uuid, product_name.
mig: gpu_uuid, gpu_product_name, gpu_instance_id

Metric	Scope	Dimensions	Units	XML	CSV
gpu_pcie_bandwidth_usage	gpu	rx, tx	B/s	yes	no
gpu_pcie_bandwidth_utilization	gpu	rx, tx	%	yes	no
gpu_fan_speed_perc	gpu	fan_speed	%	yes	yes
gpu_utilization	gpu	gpu	%	yes	yes
gpu_memory_utilization	gpu	memory	%	yes	yes
gpu_decoder_utilization	gpu	decoder	%	yes	no
gpu_encoder_utilization	gpu	encoder	%	yes	no
gpu_frame_buffer_memory_usage	gpu	free, used, reserved	B	yes	yes
gpu_bar1_memory_usage	gpu	free, used	B	yes	no
gpu_temperature	gpu	temperature	Celsius	yes	yes
gpu_voltage	gpu	voltage	V	yes	no
gpu_clock_freq	gpu	graphics, video, sm, mem	MHz	yes	yes
gpu_power_draw	gpu	power_draw	Watts	yes	yes
gpu_performance_state	gpu	P0-P15	state	yes	yes
gpu_mig_mode_current_status	gpu	enabled, disabled	status	yes	no
gpu_mig_devices_count	gpu	mig	devices	yes	no
gpu_mig_frame_buffer_memory_usage	mig	free, used, reserved	B	yes	no
gpu_mig_bar1_memory_usage	mig	free, used	B	yes	no

Configuration

This module supports data collection in CSV and XML formats. The default is CSV.

XML provides more metrics, but requesting GPU information consumes more CPU, especially if there are multiple GPU cards in the system.
CSV provides fewer metrics, but is much lighter than XML in terms of CPU usage.

The format can be changed in the configuration file.

Edit the go.d/nvidia_smi.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

jobs:
  - name: nvidia_smi
    use_csv_format: no # set to 'no' to use the XML format.

Troubleshooting

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
```

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Timeout      web.Duration
	BinaryPath   string `yaml:"binary_path"`
	UseCSVFormat bool   `yaml:"use_csv_format"`
}

type NvidiaSMI ¶

type NvidiaSMI struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New ¶

func New() *NvidiaSMI

func (*NvidiaSMI) Charts ¶

func (nv *NvidiaSMI) Charts() *module.Charts

func (*NvidiaSMI) Check ¶

func (nv *NvidiaSMI) Check() bool

func (*NvidiaSMI) Cleanup ¶

func (nv *NvidiaSMI) Cleanup()

func (*NvidiaSMI) Collect ¶

func (nv *NvidiaSMI) Collect() map[string]int64

func (*NvidiaSMI) Init ¶

func (nv *NvidiaSMI) Init() bool

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL