Directory

Agent Check

Supported OS:

Overview

Capture metrics from directories and files of your choosing. The Agent collects:

• Number of files
• File size
• Age of the last modification
• Age of the creation

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

The Directory check is included in the Datadog Agent package, so you don’t need to install anything else on your server.

Configuration

1. Edit the directory.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting Directory performance data. See the sample directory.d/conf.yaml for all available configuration options.

  init_config:

instances:
- directory: "/path/to/directory" # the only required option
name: "my_monitored_dir"        # What the Agent will tag this directory's metrics with. Defaults to "directory"
pattern: "*.log"                # defaults to "*" (all files)
recursive: True                 # default False
countonly: False                # set to True to only collect the number of files matching 'pattern'. Useful for very large directories.
ignore_missing: False           # set to True to not raise exceptions on missing or inaccessible directories

Ensure that the user running the Agent process (usually datadog-agent) has read access to the directories, subdirectories, and files you configure.

Note: On Windows when you add your directory, use double-backslashes C:\\path\\to\\directory instead of single-backslashes C:\path\to\directory for the check to run. Otherwise, the directory check fails with traceback ending in the error: found unknown escape character in "<string>".

Metrics collection

The Directory check can potentially emit custom metrics, which may impact your billing.

Validation

Run the Agent’s status subcommand and look for directory under the Checks section.

Data Collected

Metrics

 system.disk.directory.file.bytes(gauge) Total size of the fileShown as byte system.disk.directory.file.modified_sec_ago(gauge) Duration since last modificationShown as second system.disk.directory.file.created_sec_ago(gauge) Duration since creationShown as second system.disk.directory.files(gauge) Number of files in the directoryShown as file system.disk.directory.bytes(gauge) Total size of the directoryShown as byte

Events

The Directory check does not include any events.

Service Checks

The Directory check does not include any service checks.