You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pipeline/inputs/gpu-metrics.md
+15-17Lines changed: 15 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,23 @@
1
1
# GPU metrics
2
2
3
-
The **gpu_metrics** input plugin collects graphics processing unit (GPU) performance metrics from graphics cards on Linux systems. It provides real-time monitoring of GPU utilization, memory usage (VRAM), clock frequencies, power consumption, temperature, and fan speeds.
3
+
The _gpu_metrics_ input plugin collects graphics processing unit (GPU) performance metrics from graphics cards on Linux systems. It provides real-time monitoring of GPU utilization, memory usage (VRAM), clock frequencies, power consumption, temperature, and fan speeds.
4
4
5
-
The plugin reads metrics directly from the Linux sysfs filesystem (`/sys/class/drm/`) without requiring external tools or libraries. Currently, **only AMD GPUs are supported** through the amdgpu kernel driver. NVIDIA and Intel GPUs aren't supported at this time.
5
+
The plugin reads metrics directly from the Linux `sysfs` filesystem (`/sys/class/drm/`) without requiring external tools or libraries. Only AMD GPUs are supported through the `amdgpu` kernel driver. NVIDIA and Intel GPUs aren't supported at this time.
6
6
7
7
## Metrics collected
8
8
9
9
The plugin collects the following metrics for each detected GPU:
|`gpu_utilization_percent`| GPU core utilization as a percentage (0-100). Indicates how busy the GPU is processing workloads. |
14
-
|`gpu_memory_used_bytes`| Amount of video RAM (VRAM) currently in use, measured in bytes. |
15
-
|`gpu_memory_total_bytes`| Total video RAM (VRAM) capacity available on the GPU, measured in bytes. |
11
+
| Key | Description |
12
+
|---------------------------|------------------|
13
+
|`gpu_utilization_percent`| GPU core utilization as a percentage (0-100). Indicates how busy the GPU is processing workloads. |
14
+
|`gpu_memory_used_bytes`| Amount of video RAM (VRAM) currently in use, measured in bytes. |
15
+
|`gpu_memory_total_bytes`| Total video RAM (VRAM) capacity available on the GPU, measured in bytes. |
16
16
|`gpu_clock_mhz`| Current GPU clock frequency in MHz. This metric has multiple instances with different type labels (see [Clock metrics](#clock-metrics)). |
17
-
|`gpu_power_watts`| Current power consumption in watts. Can be disabled with enable_power false. |
18
-
|`gpu_temperature_celsius`| GPU die temperature in degrees Celsius. Can be disabled with enable_temperaturefalse. |
19
-
|`gpu_fan_speed_rpm`| Fan rotation speed in revolutions per minute (RPM).|
20
-
|`gpu_fan_pwm_percent`| Fan PWM duty cycle as a percentage (0-100). Indicates fan intensity. |
17
+
|`gpu_power_watts`| Current power consumption in watts. Can be disabled with `enable_power` set to `false`.|
18
+
|`gpu_temperature_celsius`| GPU die temperature in degrees Celsius. Can be disabled with `enable_temperature`set to `false`.|
19
+
|`gpu_fan_speed_rpm`| Fan rotation speed in Revolutions per Minute (RPM). |
20
+
|`gpu_fan_pwm_percent`| Fan PWM duty cycle as a percentage (0-100). Indicates fan intensity. |
21
21
22
22
### Clock metrics
23
23
@@ -33,18 +33,18 @@ The `gpu_clock_mhz` metric is reported separately for three clock domains:
33
33
34
34
The plugin supports the following configuration parameters:
|`scrape_interval`| Interval in seconds between metric collection cycles. |`5`|
39
-
|`path_sysfs`| Path to the sysfs root directory. Typically used for testing or non-standard systems. |`/sys`|
39
+
|`path_sysfs`| Path to the `sysfs` root directory. Typically used for testing or non-standard systems. |`/sys`|
40
40
|`cards_include`| Pattern specifying which GPU cards to monitor. Supports wildcards (*), ranges (0-3), and comma-separated lists (0,2,4). |`*`|
41
-
|`cards_exclude`| Pattern specifying which GPU cards to exclude from monitoring. Uses the same syntax as cards_include. |_none_|
41
+
|`cards_exclude`| Pattern specifying which GPU cards to exclude from monitoring. Uses the same syntax as `cards_include`. |_none_|
42
42
|`enable_power`| Enable collection of power consumption metrics (`gpu_power_watts`). |`true`|
43
43
|`enable_temperature`| Enable collection of temperature metrics (`gpu_temperature_celsius`). |`true`|
44
44
45
45
## GPU detection
46
46
47
-
The GPU metrics plugin will automatically scan for supported **AMD GPUs** that are using the `amdgpu` kernel driver. GPUs using legacy drivers will be ignored.
47
+
The GPU metrics plugin will automatically scan for any supported AMD GPU are using the `amdgpu` kernel driver. A GPU using legacy drivers will be ignored.
0 commit comments