Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 3.54 KB

disk-io.md

File metadata and controls

74 lines (51 loc) · 3.54 KB

disk-io

Monitor Type: disk-io (Source)

Accepts Endpoints: No

Multiple Instances Allowed: Yes

Overview

This monitor reports I/O metrics about disks.

On Linux hosts, this monitor relies on the /proc filesystem. If the underlying host's /proc file system is mounted somewhere other than /proc please specify the path using the top level configuration procPath.

procPath: /proc
monitors:
 - type: disk-io

Configuration

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: disk-io
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
disks no list of strings The devices to include/exclude. This is an overridable set. (default: [* !/^loop[0-9]+$/ !/^dm-[0-9]+$/])
counterRefreshInterval no int64 (Windows Only) The frequency that wildcards in counter paths should be expanded and how often to refresh counters from configuration. This is expressed as a duration. (default: 60s)
printValid no bool (Windows Only) Print out the configurations that match available performance counters. This used for debugging. (default: false)

Metrics

These are the metrics available for this monitor. This monitor emits all metrics by default; however, none are categorized as container/host -- they are all custom.

  • disk_merged.read (cumulative)
    (Linux Only) The number of disk reads merged into single physical disk access operations.
  • disk_merged.write (cumulative)
    (Linux Only) The number of disk writes merged into single physical disk access operations.
  • disk_octets.avg_read (gauge)
    (Windows Only) The average number of octets (bytes) read.
  • disk_octets.avg_write (gauge)
    (Windows Only) The average number of octets (bytes) written.
  • disk_octets.read (cumulative)
    (Linux Only) The number of bytes (octets) read from a disk.
  • disk_octets.write (cumulative)
    (Linux Only) The number of bytes (octets) written to a disk.
  • disk_ops.avg_read (gauge)
    (Windows Only) The average disk read queue length.
  • disk_ops.avg_write (gauge)
    (Windows Only) The average disk write queue length.
  • disk_ops.read (cumulative)
    (Linux Only) The number of disk read operations.
  • disk_ops.write (cumulative)
    (Linux Only) The number of disk write operations.
  • disk_time.avg_read (gauge)
    (Windows Only) The average time spent reading from the disk.
  • disk_time.avg_write (gauge)
    (Windows Only) The average time spent writing to the disk
  • disk_time.read (cumulative)
    (Linux Only) The average amount of time it took to do a read operation.
  • disk_time.write (cumulative)
    (Linux Only) The average amount of time it took to do a write operation. The agent does not do any built-in filtering of metrics coming out of this monitor.