Freeimpi yaml (#15533)
* freeimpi_yaml: Add initial description * freeimpi_yaml: Update freeimp yaml * freeimpi_yaml: Update freeimp yaml second group * freeimpi_yaml: Update description
thiagoftsm committed
Jul 26, 2023 at 07:30 UTC
2e815bbfb9bbc08c0e603c644d9875e39a58ffcc
1 file changed
+41
-25
collectors/freeipmi.plugin/multi_metadata.yaml
+41
-25
@@ -23,33 +23,42 @@ modules:
23
data_collection:
24
metrics_description:
25
"Monitor enterprise server sensor readings, event log entries, and hardware statuses to ensure reliable server operations."
26
- method_description: ""
26
+ method_description: |
27
+ The plugin uses open source library IPMImonitoring to communitcate with sensors.
28
supported_platforms:
29
include: []
30
exclude: []
31
multi_instance: true
32
additional_permissions:
32
- description: ""
33
+ description: "The plugin needs setuid."
34
default_behavior:
35
auto_detection:
36
description: ""
37
limits:
38
description: ""
39
performance_impact:
39
- description: ""
40
+ description: "Linux kernel module for IPMI can create big overhead."
41
setup:
42
prerequisites:
42
- list: []
43
+ list: |
44
+ If you have not previously used IPMI on your system, you will probably need to run the ipmimonitoring command as root to initiailze IPMI settings so that the Netdata plugin works correctly. It should return information about available seensors on the system.
45
+
46
+ In some distributions libipmimonitoring.pc is located in a non-standard directory, which can cause building the plugin to fail when building Netdata from source. In that case you should find the file and link it to the standard pkg-config directory. Usually, running sudo ln -s /usr/lib/$(uname -m)-linux-gnu/pkgconfig/libipmimonitoring.pc/libipmimonitoring.pc /usr/lib/pkgconfig/libipmimonitoring.pc resolves this issue.
47
configuration:
48
file:
45
- name: ""
46
- description: ""
49
+ name: "netdata.conf"
50
+ section_name: '[plugin:freeipmi]'
51
+ description: "This is netdata main configuration file"
52
options:
48
- description: ""
53
+ description: "This tool receives command line options that are visible when user run: `./usr/libexec/netdata/plugins.d/freeipmi.plugin --help`"
54
folding:
50
- title: ""
55
+ title: "Config options"
56
enabled: true
52
- list: []
57
+ list: |
58
+ - name: command options
59
+ description: Variable used to pass arguments for the plugin.
60
+ default_value: 1
61
+ required: false
62
examples:
63
folding:
64
enabled: true
@@ -74,11 +83,11 @@ modules:
83
description: ""
84
labels:
85
- name: sensor
77
- description: TBD
86
+ description: The sensor name
87
- name: type
79
- description: TBD
88
+ description: One of 45 recognized sensor types (Battery, Voltage...)
89
- name: component
81
- description: TBD
90
+ description: One of 25 recognized components (Processor, Peripheral).
91
metrics:
92
- name: ipmi.sel
93
description: IPMI Events
@@ -158,28 +167,35 @@ modules:
167
include: []
168
exclude: []
169
multi_instance: true
161
- additional_permissions:
162
- description: ""
170
+ additional_permissions: |
171
+ The plugin uses open source library IPMImonitoring to communitcate with sensors.
172
default_behavior:
173
auto_detection:
174
description: ""
175
limits:
176
description: ""
177
performance_impact:
169
- description: ""
178
+ description: "Linux kernel module for IPMI can create big overhead."
179
setup:
180
prerequisites:
172
- list: []
181
+ list: |
182
+ If you have not previously used IPMI on your system, you will probably need to run the ipmimonitoring command as root to initiailze IPMI settings so that the Netdata plugin works correctly. It should return information about available seensors on the system.
183
+
184
+ In some distributions libipmimonitoring.pc is located in a non-standard directory, which can cause building the plugin to fail when building Netdata from source. In that case you should find the file and link it to the standard pkg-config directory. Usually, running sudo ln -s /usr/lib/$(uname -m)-linux-gnu/pkgconfig/libipmimonitoring.pc/libipmimonitoring.pc /usr/lib/pkgconfig/libipmimonitoring.pc resolves this issue.
185
configuration:
174
- file:
175
- name: ""
176
- description: ""
186
+ name: "netdata.conf"
187
+ section_name: '[plugin:freeipmi]'
188
+ description: "This is netdata main configuration file"
189
options:
178
- description: ""
190
+ description: "This tool receives command line options that are visible when user run: `./usr/libexec/netdata/plugins.d/freeipmi.plugin --help`"
191
folding:
180
- title: ""
192
+ title: "Config options"
193
enabled: true
182
- list: []
194
+ list: |
195
+ - name: command options
196
+ description: Variable used to pass arguments for the plugin.
197
+ default_value: 1
198
+ required: false
199
examples:
200
folding:
201
enabled: true
@@ -204,11 +220,11 @@ modules:
220
description: ""
221
labels:
222
- name: sensor
207
- description: TBD
223
+ description: The sensor name
224
- name: type
209
- description: TBD
225
+ description: One of 45 recognized sensor types (Battery, Voltage...)
226
- name: component
211
- description: TBD
227
+ description: One of 25 recognized components (Processor, Peripheral).
228
metrics:
229
- name: ipmi.sel
230
description: IPMI Events