Metadata-Version: 2.1
Name: datadog-disk
Version: 7.4.0
Summary: The Disk check
Project-URL: Source, https://github.com/DataDog/integrations-core
Author-email: Datadog <packages@datadoghq.com>
Keywords: datadog,datadog agent,datadog check,disk
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Private :: Do Not Upload
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: System :: Monitoring
Requires-Dist: datadog-checks-base>=37.24.0
Provides-Extra: deps
Requires-Dist: psutil==6.0.0; extra == 'deps'
Description-Content-Type: text/markdown

# Disk Check

## Overview

Collect metrics related to disk usage and IO.

**Minimum Agent version:** 6.0.0

## Setup

### Installation

The disk check is included in the [Datadog Agent][1] package, so you don't need to install anything else on your server.

### Configuration

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][2]. See the [sample disk.d/conf.yaml][3] for all available configuration options.

#### Note for Windows hosts
There are three scenarios where the Disk check can be used:

1. Monitoring physical drives

  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.

2. Monitoring nested mount points

  Monitoring mounted folders within a filesystem requires Administrator permissions. This is because the underlying Windows function call [FindFirstVolumeMountPoint][9] requires administrative permissions.
  To collect those metrics without granting Administrator permissions to the Agent, use the [PDH check][4] to collect mount point metrics from the corresponding perf counters.

3. Monitoring file shares

  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.
  
4. Monitoring Cluster Shared Volumes

  Cluster Shared Volumes (CSVs) in Windows Failover Clustering require elevated access for proper discovery.
  While there may be other ways to grant the necessary permissions, running the Datadog Agent as LocalSystem is the most reliable and consistent method to ensure full CSV visibility and metric collection.

### Validation

[Run the Agent's `status` subcommand][5] and look for `disk` under the Checks section.

## Data Collected

### Metrics

See [metadata.csv][6] for a list of metrics provided by this integration.

### Events

The Disk check does not include any events.

### Service Checks

See [service_checks.json][7] for a list of service checks provided by this integration.

## Troubleshooting

Need help? Contact [Datadog support][8].


[1]: /account/settings/agent/latest
[2]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory
[3]: https://github.com/DataDog/integrations-core/blob/master/disk/datadog_checks/disk/data/conf.yaml.default
[4]: https://docs.datadoghq.com/integrations/pdh_check/#pagetitle
[5]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[6]: https://github.com/DataDog/integrations-core/blob/master/disk/metadata.csv
[7]: https://github.com/DataDog/integrations-core/blob/master/disk/assets/service_checks.json
[8]: https://docs.datadoghq.com/help/
[9]: https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-findfirstvolumemountpointw
