Supported OS
Collect metrics related to disk usage and IO.
The disk check is included in the Datadog Agent package, so you don’t need to install anything else on your server.
The Disk check is enabled by default, and the Agent collects metrics on all local partitions. To configure the check with custom options, edit the disk.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample disk.d/conf.yaml for all available configuration options.
There are three scenarios where the Disk check can be used:
Monitoring physical drives that are represented by a disk letter (for example. C:, D:, etc.) is supported out of the box by the disk check without any special considerations.
Monitoring mounted folders within a filesystem requires Administrator permissions. This is because the underlying Windows function call FindFirstVolumeMountPoint requires administrative permissions. To collect those metrics without granting Administrator permissions to the Agent, use the PDH check to collect mount point metrics from the corresponding perf counters.
Collecting mount point metrics for file shares on Windows is only supported by using the create_mounts option in the configuration.
On Windows, each mounted folder is only visible to the user who mounted the share.
Therefore, the create_mounts option allows the Agent to create the mount points to monitor in the context of the Agent’s user.
Run the Agent’s status subcommand and look for disk under the Checks section.
| system.disk.free (gauge) | The amount of disk space that is free. Shown as byte |
| system.disk.in_use (gauge) | The amount of disk space in use as a fraction of the total. Shown as fraction |
| system.disk.read_time (count) | The time in ms spent reading per device Shown as millisecond |
| system.disk.read_time_pct (gauge) | Percent of time spent reading from disk. Shown as percent |
| system.disk.total (gauge) | The total amount of disk space. Shown as byte |
| system.disk.used (gauge) | The amount of disk space in use. Shown as byte |
| system.disk.write_time (count) | The time in ms spent writing per device. Shown as millisecond |
| system.disk.write_time_pct (gauge) | Percent of time spent writing to disk. Shown as percent |
| system.fs.inodes.free (gauge) | The number of free inodes. Shown as inode |
| system.fs.inodes.in_use (gauge) | The number of inodes in use as a fraction of the total. Shown as fraction |
| system.fs.inodes.total (gauge) | The total number of inodes. Shown as inode |
| system.fs.inodes.used (gauge) | The number of inodes in use. Shown as inode |
The Disk check does not include any events.
disk.read_write
Returns CRITICAL if filesystem is in read-only mode.
Note: This service check is not enabled by default. To enable the service check, set service_check_rw to true in the disk check’s conf.yaml file.
Need help? Contact Datadog support.
