| 1 | plugin_name: ioping.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: ioping.plugin |
| 5 | module_name: ioping.plugin |
| 6 | monitored_instance: |
| 7 | name: IOPing |
| 8 | link: "https://github.com/koct9i/ioping" |
| 9 | categories: |
| 10 | - data-collection.synthetic-testing |
| 11 | icon_filename: "syslog.png" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: [] |
| 18 | overview: |
| 19 | data_collection: |
| 20 | 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." |
| 21 | method_description: "Plugin uses `ioping` command." |
| 22 | supported_platforms: |
| 23 | include: [] |
| 24 | exclude: [] |
| 25 | multi_instance: true |
| 26 | additional_permissions: |
| 27 | description: "" |
| 28 | default_behavior: |
| 29 | auto_detection: |
| 30 | description: "" |
| 31 | limits: |
| 32 | description: "" |
| 33 | performance_impact: |
| 34 | description: "" |
| 35 | setup: |
| 36 | prerequisites: |
| 37 | list: |
| 38 | - title: Install ioping |
| 39 | description: | |
| 40 | You can install the command by passing the argument `install` to the plugin (`/usr/libexec/netdata/plugins.d/ioping.plugin install`). |
| 41 | configuration: |
| 42 | file: |
| 43 | name: "ioping.conf" |
| 44 | description: "File with options to specify hardware to monitor and arguments for ioping command." |
| 45 | options: |
| 46 | description: "" |
| 47 | folding: |
| 48 | title: "Config options" |
| 49 | enabled: true |
| 50 | list: |
| 51 | - name: update_every |
| 52 | description: Data collection frequency. |
| 53 | default_value: 1s |
| 54 | required: false |
| 55 | - name: destination |
| 56 | description: The directory/file/device to ioping. |
| 57 | default_value: "" |
| 58 | required: true |
| 59 | - name: request_size |
| 60 | description: The request size in bytes to ioping the destination (symbolic modifiers are supported) |
| 61 | default_value: 4k |
| 62 | required: false |
| 63 | - name: ioping_opts |
| 64 | description: Options passed to `ioping` commands. |
| 65 | default_value: -T 1000000 |
| 66 | required: false |
| 67 | examples: |
| 68 | folding: |
| 69 | enabled: true |
| 70 | title: "Config" |
| 71 | list: |
| 72 | - name: Basic Configuration |
| 73 | description: This example has the minimum configuration necessary to have the plugin running. |
| 74 | config: | |
| 75 | destination="/dev/sda" |
| 76 | troubleshooting: |
| 77 | problems: |
| 78 | list: [] |
| 79 | alerts: |
| 80 | - name: ioping_disk_latency |
| 81 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/ioping.conf |
| 82 | metric: ioping.latency |
| 83 | info: average I/O latency over the last 10 seconds |
| 84 | metrics: |
| 85 | folding: |
| 86 | title: Metrics |
| 87 | enabled: false |
| 88 | description: "" |
| 89 | availability: [] |
| 90 | scopes: |
| 91 | - name: disk |
| 92 | description: "" |
| 93 | labels: [] |
| 94 | metrics: |
| 95 | - name: ioping.latency |
| 96 | description: Read Latency |
| 97 | unit: "microseconds" |
| 98 | chart_type: line |
| 99 | dimensions: |
| 100 | - name: latency |