netdata/collectors/diskspace.plugin/integrations/disk_space.md

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:

Label	Description
mount_point	Path used to mount a filesystem
filesystem	The filesystem used to format a partition.
mount_root	Root directory where mount points are present.

Metrics:

Metric	Dimensions	Unit
disk.space	avail, used, reserved_for_root	GiB
disk.inodes	avail, used, reserved_for_root	inodes

Alerts

The following alerts are available:

Alert name	On metric	Description
disk_space_usage	disk.space	disk ${label:mount_point} space utilization
disk_inode_usage	disk.inodes	disk ${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

| Name | Description | Default | Required | |:----|:-----------|:-------|:--------:| | update every | Data collection frequency. | 1 | no | | remove charts of unmounted disks | Remove chart when a device is unmounted on host. | yes | no | | check for new mount points every | Parse proc files frequency. | 15 | no | | exclude space metrics on paths | Do 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 filesystems | Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern. | *gvfs *gluster* *s3fs *ipfs *davfs2 *httpfs *sshfs *gdfs *moosefs fusectl autofs | no | | exclude inode metrics on filesystems | Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern. | msdosfs msdos vfat overlayfs aufs* *unionfs | no | | space usage for all disks | Define 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. | auto | no | | inodes usage for all disks | Define 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. | auto | no |

Examples

There are no configuration examples.