Puppet Class: datadog_agent::integrations::disk

Inherits:
datadog_agent::params
Defined in:
manifests/integrations/disk.pp

Overview

Class: datadog_agent::integrations::disk

This class will install the necessary config to hook the disk check

See the sample disk.d/conf.yaml for all available configuration options github.com/DataDog/integrations-core/blob/master/disk/datadog_checks/disk/data/conf.yaml.default

Parameters:

$use_mount
    The use_mount parameter will instruct the check to collect disk
    and fs metrics using mount points instead of volumes.
    (values: yes, no)
$all_partitions
    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. (values: yes, no)
$tag_by_filesystem
    The (optional) tag_by_filesystem parameter will instruct the check to
    tag all disks with their filesystem (for ex: filesystem:nfs)
    (values: yes, no)
$filesystem_exclude
    The (optional) filesystems you wish to exclude, example: tmpfs, run,
    dev (string or array)
$device_exclude
    The (optional) devices you wish to exclude, example: /dev/sda (string or array)
$mountpoint_exclude
    The (optional) mountpoints you wish to exclude, example: /tmp,
    /mnt/somebody-elses-problem (string or array)
$filesystem_include
    Specify (optional) filesystems, to only collect from them (string or array)
$device_include
    Specify (optional) devices, to only collect from them (string or array)
$mountpoint_include
    Specify (optional) mountpoints, to only collect from them (string or array)
$filesystem_blacklist (DEPRECATED in agent version>7.24, use $filesystem_exclude instead)
    The (optional) filesystems you wish to exclude, example: tmpfs, run,
    dev (string or array)
$device_blacklist (DEPRECATED in agent version>7.24, use $device_exclude instead)
    The (optional) devices you wish to exclude, example: /dev/sda (string or array)
$mountpoint_blacklist (DEPRECATED in agent version>7.24, use $mountpoint_exclude instead)
    The (optional) mountpoints you wish to exclude, example: /tmp,
    /mnt/somebody-elses-problem (string or array)
$filesystem_whitelist  DEPRECATED in agent version>7.24, use $device_include instead)
    Specify (optional) filesystems, to only collect from them (string or array)
$device_whitelist (DEPRECATED in agent version>7.24, use $device_include instead)
    Specify (optional) devices, to only collect from them (string or array)
$mountpoint_whitelist (DEPRECATED in agent version>7.24, use $mountpoint_include instead)
    Specify (optional) mountpoints, to only collect from them (string or array)
$excluded_filesystems (DEPRECATED in agent version>6.9, use $filesystem_exclude instead)
    The filesystems you wish to exclude, example: tmpfs, run (string or array)
$excluded_disks (DEPRECATED in agent version>6.9, use $device_exclude instead)
    The disks you (optional)
$excluded_disk_re (DEPRECATED in agent version>6.9, use $device_exclude instead)
    Regular expression (optional) to exclude disks, eg: /dev/sde.*
$excluded_mountpoint_re (DEPRECATED in agent version>6.9, use $mountpoint_exclude instead)
    Regular expression (optional) to exclude , eg: /mnt/somebody-elses-problem.*

Sample Usage:

class { 'datadog_agent::integrations::disk' :
    use_mount            => 'yes',
    excluded_filesystems => '/dev/tmpfs',
    excluded_disk_re     => '/dev/sd[e-z]*'
}

Parameters:

  • use_mount (Optional[Boolean]) (defaults to: undef)
  • all_partitions (Optional[Boolean]) (defaults to: undef)
  • tag_by_filesystem (Optional[Boolean]) (defaults to: undef)
  • filesystem_exclude (Optional[Array[String]]) (defaults to: undef)
  • device_exclude (Optional[Array[String]]) (defaults to: undef)
  • mountpoint_exclude (Optional[Array[String]]) (defaults to: undef)
  • filesystem_include (Optional[Array[String]]) (defaults to: undef)
  • device_include (Optional[Array[String]]) (defaults to: undef)
  • mountpoint_include (Optional[Array[String]]) (defaults to: undef)
  • filesystem_blacklist (Optional[Array[String]]) (defaults to: undef)
  • device_blacklist (Optional[Array[String]]) (defaults to: undef)
  • mountpoint_blacklist (Optional[Array[String]]) (defaults to: undef)
  • filesystem_whitelist (Optional[Array[String]]) (defaults to: undef)
  • device_whitelist (Optional[Array[String]]) (defaults to: undef)
  • mountpoint_whitelist (Optional[Array[String]]) (defaults to: undef)
  • excluded_filesystems (Optional[Variant[String, Array[String]]]) (defaults to: undef)
  • excluded_disks (Optional[Variant[String, Array[String]]]) (defaults to: undef)
  • excluded_disk_re (Optional[String]) (defaults to: undef)
  • excluded_mountpoint_re (Optional[String]) (defaults to: undef) 


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'manifests/integrations/disk.pp', line 65

class datadog_agent::integrations::disk (
  Optional[Boolean] $use_mount                   = undef,
  Optional[Boolean] $all_partitions              = undef,
  Optional[Boolean] $tag_by_filesystem           = undef,
  Optional[Array[String]] $filesystem_exclude    = undef,
  Optional[Array[String]] $device_exclude        = undef,
  Optional[Array[String]] $mountpoint_exclude    = undef,
  Optional[Array[String]] $filesystem_include    = undef,
  Optional[Array[String]] $device_include        = undef,
  Optional[Array[String]] $mountpoint_include    = undef,
  Optional[Array[String]] $filesystem_blacklist  = undef, # deprecated in agent version >7.24
  Optional[Array[String]] $device_blacklist      = undef, # deprecated in agent version >7.24
  Optional[Array[String]] $mountpoint_blacklist  = undef, # deprecated in agent version >7.24
  Optional[Array[String]] $filesystem_whitelist  = undef, # deprecated in agent version >7.24
  Optional[Array[String]] $device_whitelist      = undef, # deprecated in agent version >7.24
  Optional[Array[String]] $mountpoint_whitelist  = undef, # deprecated in agent version >7.24
  Optional[Variant[String, Array[String]]] $excluded_filesystems   = undef,  # deprecated in agent versions >6.9
  Optional[Variant[String, Array[String]]] $excluded_disks         = undef,  # deprecated in agent versions >6.9
  Optional[String] $excluded_disk_re       = undef,  # deprecated in agent versions >6.9
  Optional[String] $excluded_mountpoint_re = undef,  # deprecated in agent versions >6.9
) inherits datadog_agent::params {
  require datadog_agent

  $dst_dir = "${datadog_agent::params::conf_dir}/disk.d"

  file { $dst_dir:
    ensure  => directory,
    owner   => $datadog_agent::dd_user,
    group   => $datadog_agent::params::dd_group,
    mode    => $datadog_agent::params::permissions_directory,
    require => Package[$datadog_agent::params::package_name],
    notify  => Service[$datadog_agent::params::service_name],
  }
  $dst = "${dst_dir}/conf.yaml"

  file { $dst:
    ensure  => file,
    owner   => $datadog_agent::dd_user,
    group   => $datadog_agent::params::dd_group,
    mode    => $datadog_agent::params::permissions_protected_file,
    content => template('datadog_agent/agent-conf.d/disk.yaml.erb'),
    require => Package[$datadog_agent::params::package_name],
    notify  => Service[$datadog_agent::params::service_name],
  }
}