Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new filtering options, continue deprecations #2483

Merged
merged 3 commits into from
Oct 30, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
172 changes: 119 additions & 53 deletions disk/datadog_checks/disk/data/conf.yaml.default
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,123 @@
init_config:

instances:
# The use_mount parameter will instruct the check to collect disk
# and fs metrics using mount points instead of volumes
## @param use_mount - boolean - required
## Instruct the check to collect using mount points instead of volumes.
#
- use_mount: false
# The (optional) excluded_filesystems parameter will instruct the check to
# ignore disks using these filesystems. Note: On some linux distributions,
# rootfs will be found and tagged as a device, add rootfs here to exclude.
# excluded_filesystems:
# - tmpfs

# The (optional) excluded_disks parameter will instruct the check to
# ignore this list of disks.
# Linux example:
# excluded_disks:
# - /dev/sda1
# - /dev/sda2
#
# Windows example:
# excluded_disks:
# - F:\
#
# The (optional) excluded_disk_re parameter will instruct the check to
# ignore all disks matching this regex.
# excluded_disk_re: /dev/sde.*
#
# The (optional) tag_by_filesystem parameter will instruct the check to
# tag all disks with their filesystem (for ex: filesystem:nfs).
# tag_by_filesystem: false
#
# The (optional) excluded_mountpoint_re parameter will instruct the check to
# ignore all mountpoints matching this regex.
# excluded_mountpoint_re: /mnt/somebody-elses-problem.*
#
# The (optional) all_partitions parameter will instruct the check to
# get metrics for all partitions. use_mount should be set to yes (to avoid
# collecting empty device names) when using this option.
# all_partitions: false
#
# The (optional) device_tag_re parameter will instruct the check to apply additional tags to
# volumes/mountpoints matching these regexes. Multiple comma-separated tags are supported.
# You must properly quote the string if the pattern contains special characters e.g. colons.
# Character casing is ignored on Windows.
# device_tag_re:
# /san/.*: device_type:san
# /dev/sda3: role:db,disk_size:large
# "c:": volume:boot
#
# The (optional) tags parameter allows you to customize tags for the instance
# tags:
# - optional_tag1
# - optional_tag2
#
# The (optional) service_check_rw parameter notifies when one of the partitions is in
# read-only mode
# service_check_rw: false

## @param all_partitions - boolean - optional
## Instruct the check to collect from partitions even without device names.
## Setting `use_mount` to true is strongly recommended in this case.
#
# all_partitions: false

## @param tags - list of key:value string - optional
## List of tags to attach to every metric and service check emitted by this integration.
##
## Learn more about tagging at https://docs.datadoghq.com/tagging
#
# tags:
# - <KEY_1>:<VALUE_1>
# - <KEY_2>:<VALUE_2>

## @param file_system_whitelist - list of regex - optional
## Instruct the check to only collect from matching file systems.
##
## Character casing is ignored. For convenience, the regular expressions
## start matching from the beginning and therefore to match anywhere you
## must prepend `.*`. For exact matches append `$`.
#
# file_system_whitelist:
# - ext[34]$
# - ntfs$

## @param file_system_blacklist - list of regex - optional
## Instruct the check to not collect from matching file systems.
##
## Character casing is ignored. For convenience, the regular expressions
## start matching from the beginning and therefore to match anywhere you
## must prepend `.*`. For exact matches append `$`.
##
## When conflicts arise, this will override `file_system_whitelist`.
#
# file_system_blacklist:
# - tmpfs$
# - rootfs$
# - autofs$
# - .*binfmt_misc

## @param device_whitelist - list of regex - optional
## Instruct the check to only collect from matching devices.
##
## Character casing is ignored on Windows. For convenience, the regular
## expressions start matching from the beginning and therefore to match
## anywhere you must prepend `.*`. For exact matches append `$`.
#
# device_whitelist:
# - /dev/sda[1-3]
# - C:

## @param device_blacklist - list of regex - optional
## Instruct the check to not collect from matching devices.
##
## Character casing is ignored on Windows. For convenience, the regular
## expressions start matching from the beginning and therefore to match
## anywhere you must prepend `.*`. For exact matches append `$`.
##
## When conflicts arise, this will override `device_whitelist`.
#
# device_blacklist:
# - /dev/sde
# - [FJ]:

## @param mount_point_whitelist - list of regex - optional
## Instruct the check to only collect from matching mount points.
##
## Character casing is ignored on Windows. For convenience, the regular
## expressions start matching from the beginning and therefore to match
## anywhere you must prepend `.*`. For exact matches append `$`.
#
# mount_point_whitelist:
# - /dev/sda[1-3]
# - C:

## @param mount_point_blacklist - list of regex - optional
## Instruct the check to not collect from matching mount points.
##
## Character casing is ignored on Windows. For convenience, the regular
## expressions start matching from the beginning and therefore to match
## anywhere you must prepend `.*`. For exact matches append `$`.
##
## When conflicts arise, this will override `mount_point_whitelist`.
#
# mount_point_blacklist:
# - /dev/sde
# - [FJ]:

## @param service_check_rw - boolean - optional
## Instruct the check to notify based on partition state.
##
## read-write -> OK
## read-only -> CRITICAL
## other -> UNKNOWN
#
# service_check_rw: false

## @param tag_by_filesystem - boolean - optional
## Instruct the check to tag all disks with their file system e.g. filesystem:ntfs.
#
# tag_by_filesystem: false

## @param device_tag_re - list of regex:tags string - optional
## Instruct the check to apply additional tags to matching
## devices (or mount points if `use_mount` is true).
##
## Character casing is ignored on Windows. Multiple comma-separated
## tags are supported. You must properly quote the string if the
## pattern contains special characters e.g. colons.
#
# device_tag_re:
# /san/.*: device_type:san
# /dev/sda3: role:db,disk_size:large
# "c:": volume:boot
Loading