Skip to main content

Disk space

Plugin: diskspace.plugin Module: diskspace.plugin

Overview

Monitor Disk space metrics for proficient storage management. Keep track of usage, free space, and error rates to prevent disk space issues.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

The plugin reads data from /proc/self/mountinfo and /proc/diskstats file.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

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

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 mount point

Labels:

LabelDescription
mount_pointPath used to mount a filesystem
filesystemThe filesystem used to format a partition.
mount_rootRoot directory where mount points are present.

Metrics:

MetricDimensionsUnit
disk.spaceavail, used, reserved_for_rootGiB
disk.inodesavail, used, reserved_for_rootinodes

Alerts

The following alerts are available:

Alert nameOn metricDescription
disk_space_usage disk.spacedisk ${label:mount_point} space utilization
disk_inode_usage disk.inodesdisk ${label:mount_point} inode utilization

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is netdata.conf. Configuration for this specific integration is located in the [plugin:proc:diskspace] 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

Options

You can also specify per mount point [plugin:proc:diskspace:mountpoint]

Config options
NameDescriptionDefaultRequired
update everyData collection frequency.1no
remove charts of unmounted disksRemove chart when a device is unmounted on host.yesno
check for new mount points everyParse proc files frequency.15sno
exclude space metrics on pathsDo not show metrics (charts) for listed paths. This option accepts netdata simple pattern./proc/ /sys/ /var/run/user/ /run/user/ /snap/ /var/lib/docker/no
exclude space metrics on filesystemsDo not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern.gvfs gluster* s3fs ipfs davfs2 httpfs sshfs gdfs *moosefs fusectl autofsno
exclude inode metrics on filesystemsDo not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern.msdosfs msdos vfat overlayfs aufs* *unionfsno
space usage for all disksDefine if plugin will show metrics for space usage. When value is set to auto plugin will try to access information to display if filesystem or path was not discarded with previous option.autono
inodes usage for all disksDefine if plugin will show metrics for inode usage. When value is set to auto plugin will try to access information to display if filesystem or path was not discarded with previous option.autono

Examples

There are no configuration examples.


Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.