Skip to content

Commit 47ab62f

Browse files
authored
Updated gpu metrics input plugin doc to update configuration parameters table and standardize classic config example. Fixes #2258. (#2259)
Updated gpu metrics input plugin doc to update configuration parameters table and standardize classic config example. Fixes #2258. Signed-off-by: Eric D. Schabell <[email protected]>
1 parent 1d3edfc commit 47ab62f

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

pipeline/inputs/gpu-metrics.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ The plugin supports the following configuration parameters:
3535

3636
| Key | Description | Default |
3737
|----------------------|-------------------------------------------------------------------------------------------------------------------------|-----------|
38-
| `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` |
40-
| `cards_include` | Pattern specifying which GPU cards to monitor. Supports wildcards (*), ranges (0-3), and comma-separated lists (0,2,4). | `*` |
4138
| `cards_exclude` | Pattern specifying which GPU cards to exclude from monitoring. Uses the same syntax as `cards_include`. | _none_ |
39+
| `cards_include` | Pattern specifying which GPU cards to monitor. Supports wildcards (*), ranges (0-3), and comma-separated lists (0,2,4). | `*` |
4240
| `enable_power` | Enable collection of power consumption metrics (`gpu_power_watts`). | `true` |
4341
| `enable_temperature` | Enable collection of temperature metrics (`gpu_temperature_celsius`). | `true` |
42+
| `path_sysfs` | Path to the `sysfs` root directory. Typically used for testing or non-standard systems. | `/sys` |
43+
| `scrape_interval` | Interval in seconds between metric collection cycles. | `5` |
4444

4545
## GPU detection
4646

@@ -121,12 +121,12 @@ In your main configuration file append the following:
121121
pipeline:
122122
inputs:
123123
- name: gpu_metrics
124-
scrape_interval: 2
125-
path_sysfs: /sys
126-
cards_include: "1"
127124
cards_exclude: "0"
125+
cards_include: "1"
128126
enable_power: true
129127
enable_temperature: true
128+
path_sysfs: /sys
129+
scrape_interval: 2
130130

131131
outputs:
132132
- name: stdout
@@ -139,12 +139,12 @@ pipeline:
139139
```text
140140
[INPUT]
141141
Name gpu_metrics
142-
scrape_interval 2
143-
path_sysfs /sys
144-
cards_include 1
145-
cards_exclude 0
146-
enable_power true
147-
enable_temperature true
142+
Cards_Exclude 0
143+
Cards_Include 1
144+
Enable_Power true
145+
Enable_Temperature true
146+
Path_Sysfs /sys
147+
Scrape_Interval 2
148148

149149
[OUTPUT]
150150
Name stdout

0 commit comments

Comments
 (0)