Physical and Logical Disk Performance Metrics

Plugin: windows.plugin Module: PerflibStorage

Overview

Detailed statistics for all disk devices and volumes.

It uses Windows volume-space APIs for disk-space metrics, including folder-mounted and Cluster Shared Volumes, and queries the 'LogicalDisk' and 'PhysicalDisk' objects from Perflib for the remaining metrics.

This collector is only supported on the following platforms:

• windows

This collector only supports collecting metrics from a single instance of this integration.

Default Behavior

Auto-Detection

The collector automatically detects all of the metrics, no further configuration is required.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

Prerequisites

No action required.

Configuration

Options

Option	Description	Default	Required
update every	Data collection frequency.	1	no
exclude space metrics on paths	Space-separated, case-insensitive Netdata simple patterns for logical-volume mount points to exclude from disk space collection. Patterns support * wildcards and ! negative terms. For example, *AssuredRecoveryTemp* excludes temporary backup volumes with that path component.		no

via File

The configuration file name for this integration is netdata.conf. Configuration for this specific integration is located in the [plugin:windows:PerflibStorage] section within that file.

The file format is a modified INI syntax. The general structure is:

[section1]
    option1 = some value
    option2 = some other value

[section2]
    option3 = some third value

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf

Examples

Exclude temporary backup volumes

Exclude logical-volume disk space metrics for mount points that contain AssuredRecoveryTemp.

Configuration

[plugin:windows:PerflibStorage]
  exclude space metrics on paths = *AssuredRecoveryTemp*

Alerts

The following alerts are available:

Alert name	On metric	Description
Alert name disk_space_usage	On metricdisk.space	DescriptionTotal space utilization of disk ${label:mount_point}
Alert name disk_fill_rate	On metricdisk.space	Descriptionaverage rate the disk fills up (positive), or frees up (negative) space, for the last hour
Alert name out_of_disk_space_time	On metricdisk.space	DescriptionEstimated time the disk ${label:mount_point} will run out of space, if the system continues to add data with the rate of the last hour
Alert name 10min_disk_utilization	On metricdisk.util	DescriptionAverage percentage of time ${label:device} disk was busy over the last 10 minutes

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per System

These metrics refer to the entire System.

This scope has no labels.

Metrics:

Metric	Description	Dimensions	Unit
system.io	Disk I/O	reads, writes	KiB/s

Per Logical Disk

These metrics refer to Logical Disks. Volumes without a drive letter are included, addressed by the folder they are mounted on - this covers Cluster Shared Volumes on failover-cluster nodes, which Windows exposes only below the system drive, as '%SystemDrive%\ClusterStorage\VolumeN' (for example 'C:\ClusterStorage\Volume1').

Labels:

Label	Description
mount_point	Drive letter or mount point path assigned by Windows (e.g., 'C:', 'D:', 'C:\ClusterStorage\Volume1').
drive_type	Classification of the disk device (e.g., norootdir, removable, fixed, remote, cdrom, ramdisk).
filesystem	File system format used on the volume (e.g., ntfs, refs, csvfs).
rw_mode	Current read/write permissions status of the volume (read-only access, read and write access).
serial_number	Volume serial number reported by Windows, in hexadecimal.

Metrics:

Metric	Description	Dimensions	Unit
disk.space	Disk Space Usage	avail, used	GiB

Per Physical Disk

These metrics refer to Physical Disks.

Labels:

Label	Description
mount_point	Drive letter or mount point path assigned by Windows (e.g., 'C:', 'D:').
device	Manufacturer model name.
model	The device model.
device_id	Unique hardware identifier for the storage device within the system.

Metrics:

Metric	Description	Dimensions	Unit
disk.io	Disk I/O Bandwidth	reads, writes	KiB/s
disk.avgsz	Average Completed I/O Operation Bandwidth	reads, writes	KiB/operation
disk.ops	Disk Completed I/O Operations	reads, writes	operations/s
disk.split	Split I/O Operations	discards	operations/s
disk.await	Average Completed I/O Operation Time	reads, writes	milliseconds/operation
disk.svctm	Average Service Time	svctm	milliseconds/operation
disk.util	Disk Utilization Time	utilization	percent
disk.busy	Disk Busy Time	busy	milliseconds
disk.iotime	Disk Total I/O Time	reads, writes	milliseconds/s
disk.qops	Disk Current I/O Operations	operations	operations