Update ioping yaml (#15534)
thiagoftsm committed
Jul 27, 2023 at 12:06 UTC
88513033fea136d11a1342c68299a82d75fff316
1 file changed
+42
-17
collectors/ioping.plugin/metadata.yaml
+42
-17
@@ -1,54 +1,79 @@
1
+# yamllint disable rule:line-length
2
+---
3
meta:
4
plugin_name: ioping.plugin
5
module_name: ioping.plugin
6
monitored_instance:
7
name: IOPing
6
- link: ''
8
+ link: "https://github.com/koct9i/ioping"
9
categories:
10
- data-collection.synthetic-checks
9
- icon_filename: 'syslog.png'
11
+ icon_filename: "syslog.png"
12
related_resources:
13
integrations:
14
list: []
15
info_provided_to_referring_integrations:
14
- description: ''
16
+ description: ""
17
keywords: []
18
most_popular: false
19
overview:
20
data_collection:
19
- metrics_description: 'Monitor IOPing metrics for efficient disk I/O latency tracking. Keep track of read/write speeds, latency, and error rates for optimized disk operations.'
20
- method_description: ''
21
+ metrics_description: "Monitor IOPing metrics for efficient disk I/O latency tracking. Keep track of read/write speeds, latency, and error rates for optimized disk operations."
22
+ method_description: "Plugin uses `ioping` command."
23
supported_platforms:
24
include: []
25
exclude: []
26
multi_instance: true
27
additional_permissions:
26
- description: ''
28
+ description: ""
29
default_behavior:
30
auto_detection:
29
- description: ''
31
+ description: ""
32
limits:
31
- description: ''
33
+ description: ""
34
performance_impact:
33
- description: ''
35
+ description: ""
36
setup:
37
prerequisites:
36
- list: []
38
+ list:
39
+ - title: Install ioping
40
+ description: |
41
+ You can install the command by passing the argument `install` to the plugin (`/usr/libexec/netdata/plugins.d/ioping.plugin install`).
42
configuration:
43
file:
39
- name: ''
40
- description: ''
44
+ name: "ioping.conf"
45
+ description: "File with options to specify hardware to monitor and arguments for ioping command."
46
options:
42
- description: ''
47
+ description: ""
48
folding:
44
- title: ''
49
+ title: "Config options"
50
enabled: true
46
- list: []
51
+ list:
52
+ - name: update_every
53
+ description: Data collection frequency.
54
+ default_value: 1s
55
+ required: false
56
+ - name: destination
57
+ description: The directory/file/device to ioping.
58
+ default_value: ""
59
+ required: true
60
+ - name: request_size
61
+ description: The request size in bytes to ioping the destination (symbolic modifiers are supported)
62
+ default_value: 4k
63
+ required: false
64
+ - name: ioping_opts
65
+ description: Options passed to `ioping` commands.
66
+ default_value: -T 1000000
67
+ required: false
68
examples:
69
folding:
70
enabled: true
50
- title: ''
51
- list: []
71
+ title: "Config"
72
+ list:
73
+ - name: Basic Configuration
74
+ description: This example has the minimum configuration necessary to have the plugin running.
75
+ config: |
76
+ destination="/dev/sda"
77
troubleshooting:
78
problems:
79
list: []