Skip to content

Commit de989ef

Browse files
committed
fix vale linting issues
Signed-off-by: Maciej Wal <[email protected]>
1 parent a81d476 commit de989ef

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

pipeline/inputs/gpu-metrics.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
# GPU Metrics
1+
# GPU metrics
22

3-
The **gpu_metrics** input plugin collects 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.
44

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 are not supported at this time.
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.
66

7-
## Metrics Collected
7+
## Metrics collected
88

99
The plugin collects the following metrics for each detected GPU:
1010

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 VRAM currently in use, measured in bytes. |
15-
| `gpu_memory_total_bytes` | Total VRAM capacity available on the GPU, measured in bytes. |
16-
| `gpu_clock_mhz` | Current GPU clock frequency in MHz. This metric has multiple instances with different type labels (see below). |
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_temperature 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. |
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+
| `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_temperature 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. |
2121

22-
### Clock Metrics
22+
### Clock metrics
2323

24-
The gpu_clock_mhz metric is reported separately for three clock domains:
24+
The `gpu_clock_mhz` metric is reported separately for three clock domains:
2525

2626
| Type | Description |
2727
|------------|--------------------------------------|
2828
| `graphics` | GPU core/shader clock frequency. |
2929
| `memory` | VRAM clock frequency. |
3030
| `soc` | System-on-chip clock frequency. |
3131

32-
## Configuration Parameters
32+
## Configuration parameters
3333

3434
The plugin supports the following configuration parameters:
3535

@@ -39,10 +39,10 @@ The plugin supports the following configuration parameters:
3939
| `path_sysfs` | Path to the sysfs root directory. Typically used for testing or non-standard systems. | `/sys` |
4040
| `cards_include` | Pattern specifying which GPU cards to monitor. Supports wildcards (*), ranges (0-3), and comma-separated lists (0,2,4). | `*` |
4141
| `cards_exclude` | Pattern specifying which GPU cards to exclude from monitoring. Uses the same syntax as cards_include. | _none_ |
42-
| `enable_power` | Enable collection of power consumption metrics (gpu_power_watts). | `true` |
43-
| `enable_temperature` | Enable collection of temperature metrics (gpu_temperature_celsius). | `true` |
42+
| `enable_power` | Enable collection of power consumption metrics (`gpu_power_watts`). | `true` |
43+
| `enable_temperature` | Enable collection of temperature metrics (`gpu_temperature_celsius`). | `true` |
4444

45-
## GPU Detection
45+
## GPU detection
4646

4747
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.
4848

@@ -59,7 +59,7 @@ Example output:
5959
73:00.0 VGA compatible controller: Advanced Micro Devices, Inc. [AMD/ATI] Granite Ridge [Radeon Graphics] (rev c5)
6060
```
6161

62-
### Multiple GPU Systems
62+
### Multiple GPU systems
6363

6464
In systems with multiple GPUs, the GPU metrics plugin will detect all AMD cards by default. You can control which GPUs you want to monitor with the `cards_include` and `cards_exclude` parameters.
6565

@@ -76,11 +76,11 @@ Example output:
7676
/sys/class/drm/card1/device/vendor
7777
```
7878

79-
## Getting Started
79+
## Getting started
8080

8181
To get GPU metrics from your system, you can run the plugin from either the command line or through the configuration file:
8282

83-
### Command Line
83+
### Command line
8484

8585
Run the following command from the command line:
8686

@@ -110,7 +110,7 @@ Example output:
110110
2025-10-25T20:36:55.236905093Z gpu_fan_pwm_percent{card="1",vendor="amd"} = 0
111111
```
112112

113-
### Configuration File
113+
### Configuration file
114114

115115
In your main configuration file append the following:
116116

0 commit comments

Comments
 (0)