Docs » Integrations Guide » Integrations Reference » DF (Disk Free)

image0 DF (Disk Free)

Metadata associated with the df collectd plugin can be found here. The relevant code for the plugin can be found here.

DESCRIPTION

From collectd wiki:

The DF plugin collects file system usage information, i. e. basically how much space on a mounted partition is used and how much is available. It’s named after and very similar to the df(1) UNIX command that’s been around forever.
However, not all “partitions” are of interest. For example /proc and /dev usually don’t get filled and their “size” doesn’t make a lot of sense. That’s why the DF plugin offers to select only specific devices, mount points or filesystem types.

REQUIREMENTS AND DEPENDENCIES

This plugin requires:

Software Version
collectd 3.6+

INSTALLATION

If you are using the new Smart Agent, see the docs for the collectd/dfmonitor for more information. The configuration documentation below may be helpful as well, but consult the Smart Agent repo’s docs for the exact schema.

Installation and initial configuration options are available as part of the SignalFx collectdagent.

CONFIGURATION

Configuration for this plugin is kept in the main collectd.conf file.

Configuration Option Type Definition
Device Device Select partitions based on the devicename
MountPoint Directory Select partitions based on the mountpoint
FSType FSType Select partitions based on the filesystem type
IgnoreSelected true/false Invert the selection: If set to true, all partitions except the ones that match any one of the criteria are collected. By default only selected partitions are collected if a selection is made. If no selection is configured at all, all partitions are selected
ReportByDevice true/false Report using the device name rather than the mountpoint. i.e. with this false, (the default), it will report a disk as “root”, but with it true, it will be “sda1” (or whichever)
ReportInodes true/false Enables or disables reporting of free, reserved and used inodes. Defaults to inode collection being disabled.. Enable this option if inodes are a scarce resource for you, usually because many small files are stored on the disk. This is a usual scenario for mail transfer agents and web caches
ValuesAbsolute true/false Enables or disables reporting of free and used disk space in 1K-blocks. Defaults to true
ValuesPercentage true/false Enables or disables reporting of free and used disk space in percentage. Defaults to false.. This is useful for deploying collectd on the cloud, where machines with different disk size may exist. Then it is more practical to configure thresholds based on relative disk size.

USAGE

The primary use of this plugin is to track the available space on the systems filesystems. This can be used to set alerts and thresholds to avoid a filesystem from being filled to capacity.

The SignalFx collectd plugin computes aggregated utilization metrics based on the output of this plugin you can learn more by looking at the metrics for the plugin.

METRICS

Below is a list of all metrics.

Metric Name Brief Type
gauge.df_complex.free Free disk space in bytes gauge
gauge.df_complex.reserved Reserved disk space in bytes gauge
gauge.df_complex.used Used disk space in bytes gauge
gauge.df_inodes.free Number of inodes that are free. gauge
gauge.df_inodes.reserved Number of inodes reserved for the super user. gauge
gauge.df_inodes.used Number of inodes that are used. gauge
gauge.percent_bytes.free Free disk space on the file system, expressed as a percentage. gauge
gauge.percent_bytes.reserved Reserved disk space on the filesystem, expressed as a percentage. gauge
gauge.percent_bytes.used Used disk space on the file system, expressed as a percentage. gauge
gauge.percent_inodes.free Free inodes on the file system, expressed as a percentage. gauge
gauge.percent_inodes.reserved Reserved inodes on the file system, expressed as a percentage. gauge
gauge.percent_inodes.used Used inodes on the file system, expressed as a percentage. gauge

gauge.df_complex.free

gauge

This metric measures free disk space in bytes on this file system.

gauge.df_complex.reserved

gauge

This metric measures disk space in bytes reserved for the super-user on this file system.

gauge.df_complex.used

gauge

This metric measures used disk space in bytes on this file system.

gauge.df_inodes.free

gauge

This metric measures free inodes in the file system. Inodes are structures used by Unix filesystems to store metadata about files.

gauge.df_inodes.reserved

gauge

This metric measures inodes reserved for the super user in the file system. Inodes are structures used by Unix filesystems to store metadata about files.

gauge.df_inodes.used

gauge

This metric measures used inodes in the file system. Inodes are structures used by Unix filesystems to store metadata about files.

gauge.percent_bytes.free

gauge

This metric measures free disk space as a percentage of total disk space on this file system.

gauge.percent_bytes.reserved

gauge

This metric measures disk space reserved for the super-user as a percentage of total disk space of this file system.

gauge.percent_bytes.used

gauge

This metric measures used disk space as a percentage of total disk space of this file system.

gauge.percent_inodes.free

gauge

This metric measures free inodes as a percentage of total inodes in the file system. Inodes are structures used by file systems to store information about files (other than its content).

gauge.percent_inodes.reserved

gauge

This metric measures inodes reserved for the super-user as a percentage of total inodes in the file system. Inodes are structures used by file systems to store information about files (other than its content).

gauge.percent_inodes.used

gauge

This metric measures used inodes as a percentage of total inodes in the file system. Inodes are structures used by file systems to store information about files (other than its content).