@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 143 lines 3.46 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/ioping.plugin/README.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/ioping.plugin/metadata.yaml"
4 sidebar_label: "IOPing"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Synthetic Testing"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 endmeta-->
9
10 # IOPing
11
12
13 <img src="https://netdata.cloud/img/syslog.png" width="150"/>
14
15
16 Plugin: ioping.plugin
17 Module: ioping.plugin
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 Monitor IOPing metrics for efficient disk I/O latency tracking. Keep track of read/write speeds, latency, and error rates for optimized disk operations.
24
25 Plugin uses `ioping` command.
26
27 This collector is supported on all platforms.
28
29 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
30
31
32 ### Default Behavior
33
34 #### Auto-Detection
35
36 This integration doesn't support auto-detection.
37
38 #### Limits
39
40 The default configuration for this integration does not impose any limits on data collection.
41
42 #### Performance Impact
43
44 The default configuration for this integration is not expected to impose a significant performance impact on the system.
45
46 ## Setup
47
48
49 ### Prerequisites
50
51 #### Install ioping
52
53 You can install the command by passing the argument `install` to the plugin (`/usr/libexec/netdata/plugins.d/ioping.plugin install`).
54
55
56
57 ### Configuration
58
59 #### Options
60
61
62
63 <details open><summary>Config options</summary>
64
65
66
67 | Option | Description | Default | Required |
68 |:-----|:------------|:--------|:---------:|
69 | update_every | Data collection frequency. | 1s | no |
70 | destination | The directory/file/device to ioping. | | yes |
71 | request_size | The request size in bytes to ioping the destination (symbolic modifiers are supported) | 4k | no |
72 | ioping_opts | Options passed to `ioping` commands. | -T 1000000 | no |
73
74
75 </details>
76
77
78
79 #### via File
80
81 The configuration file name for this integration is `ioping.conf`.
82
83 The file format is POSIX shell script. Generally, the structure is:
84
85 ```sh
86 OPTION_1="some value"
87 OPTION_2="some other value"
88 ```
89 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
90 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
91
92 ```bash
93 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
94 sudo ./edit-config ioping.conf
95 ```
96
97 ##### Examples
98
99 ###### Basic Configuration
100
101 This example has the minimum configuration necessary to have the plugin running.
102
103 <details open><summary>Config</summary>
104
105 ```yaml
106 destination="/dev/sda"
107
108 ```
109 </details>
110
111
112
113 ## Alerts
114
115
116 The following alerts are available:
117
118 | Alert name | On metric | Description |
119 |:------------|:----------|:------------|
120 | [ ioping_disk_latency ](https://github.com/netdata/netdata/blob/master/src/health/health.d/ioping.conf) | ioping.latency | average I/O latency over the last 10 seconds |
121
122
123 ## Metrics
124
125 Metrics grouped by *scope*.
126
127 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
128
129
130
131 ### Per disk
132
133
134
135 This scope has no labels.
136
137 Metrics:
138
139 | Metric | Dimensions | Unit |
140 |:------|:----------|:----|
141 | ioping.latency | latency | microseconds |
142
143