System diskio metricset

The System diskio metricset provides disk IO metrics collected from the operating system. One event is created for each disk mounted on the system.

This metricset is available on:

  • Linux
  • macOS (requires 10.10+)
  • Windows
  • FreeBSD (amd64)

Configuration

diskio.include_devices

When the diskio metricset is enabled, you can use the diskio.include_devices option to define a list of device names to pre-filter the devices that are reported. Filters only exact matches. If not set or given [] empty array, all disk devices are returned

The following example config returns metrics for devices matching include_devices:

metricbeat.modules:
- module: system
  metricsets: ["diskio"]
  diskio.include_devices: ["sda", "sda1"]

Fields

For a description of each field in the metricset, see the exported fields section.

Here is an example document generated by this metricset:

{
    "@timestamp": "2017-10-12T08:05:34.853Z",
    "beat": {
        "hostname": "host.example.com",
        "name": "host.example.com"
    },
    "metricset": {
        "module": "system",
        "name": "diskio",
        "rtt": 115
    },
    "system": {
        "diskio": {
            "io": {
                "time": 338930
            },
            "iostat": {
                "await": 0,
                "busy": 0,
                "queue": {
                    "avg_size": 0
                },
                "read": {
                    "per_sec": {
                        "bytes": 0
                    },
                    "request": {
                        "merges_per_sec": 0,
                        "per_sec": 0
                    },
                    "await": 0
                },
                "request": {
                    "avg_size": 0
                },
                "service_time": 0,
                "write": {
                    "per_sec": {
                        "bytes": 0
                    },
                    "request": {
                        "merges_per_sec": 0,
                        "per_sec": 0
                    },
                    "await": 0
                }
            },
            "name": "sda",
            "read": {
                "bytes": 2540010496,
                "count": 128537,
                "time": 166380
            },
            "write": {
                "bytes": 110828974080,
                "count": 374728,
                "time": 2139780
            }
        }
    }
}