Puppet Class: datadog_agent::integrations::directory

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

Overview

Class: datadog_agent::integrations::directory

This class will install the necessary config to hook the directory in the agent

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

Parameters:

directory
    (Required) - string, the directory path to monitor
    This will be included as a tag: name:<name>.

name
    (Optional) - string, tag metrics with specified name. defaults to the "directory"

dirtagname
    (Optional) - string, the name of the key for the tag used for the directory, the value will be the value of "name" (see above). The resulting tag will be "<dirtagname>:<name>". defaults to "name"

filetagname
    (Optional) - string, the name of the key for the tag used for each file, the value will be the filename. The resulting tag will be "<filetagname>:<filename>". defaults to "filename"

filegauges
    (Optional) - boolean, when true stats will be an individual gauge per file (max. 20 files!) and not a histogram of the whole directory. default False

pattern
    (Optional) - string, the `fnmatch` pattern to use when reading the "directory"'s files. The pattern will be matched against the files' absolute paths and relative paths in "directory". default "*"

recursive
    (Optional) - boolean, when true the stats will recurse into directories. default False

countonly
    (Optional) - boolean, when true the stats will only count the number of files matching the pattern. Useful for very large directories.

Sample Usage:

Add a class for each check instance:

class { ‘datadog_agent::integrations::directory’:

directory => '/opt/ftp_data',
recursive => true,
countonly => true,

}

Add multiple instances in one class declaration:

class { ‘datadog_agent::integrations::directory’:

instances => [{
  'directory' => '/opt/ftp_data',
  'recursive' => true,
  'countonly' => true,
  },
  'directory' => '/opt/ftp_data-staging',
  'recursive' => true,
  'countonly' => true,
  },
]

}

Parameters:

  • directory (String) (defaults to: '')
  • filegauges (Boolean) (defaults to: false)
  • recursive (Boolean) (defaults to: true)
  • countonly (Boolean) (defaults to: false)
  • nametag (String) (defaults to: '')
  • dirtagname (String) (defaults to: '')
  • filetagname (String) (defaults to: '')
  • pattern (String) (defaults to: '')
  • instances (Optional[Array]) (defaults to: undef) 


59
60
61
62
63
64
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
110
111
112
113
114
 
# File 'manifests/integrations/directory.pp', line 59

class datadog_agent::integrations::directory (
  String $directory          = '',
  Boolean $filegauges        = false,
  Boolean $recursive         = true,
  Boolean $countonly         = false,
  String $nametag            = '',
  String $dirtagname         = '',
  String $filetagname        = '',
  String $pattern            = '',
  Optional[Array] $instances = undef,
) inherits datadog_agent::params {
  require datadog_agent

  if !$instances and $directory == '' {
    fail('bad directory argument and no instances hash provided')
  }

  if !$instances and $directory {
    $_instances = [{
        'directory'   => $directory,
        'filegauges'  => $filegauges,
        'recursive'  => $recursive,
        'countonly' => $countonly,
        'name' => $nametag,
        'dirtagname' => $dirtagname,
        'filetagname' => $filetagname,
        'pattern' => $pattern,
    }]
  } elsif !$instances {
    $_instances = []
  } else {
    $_instances = $instances
  }

  $dst_dir = "${datadog_agent::params::conf_dir}/directory.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/directory.yaml.erb'),
    require => Package[$datadog_agent::params::package_name],
    notify  => Service[$datadog_agent::params::service_name],
  }
}