Puppet Class: datadog_agent::integrations::docker_daemon

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

Overview

Class: datadog_agent::integrations::docker_daemon

This class will install the necessary configuration for the docker integration

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

Parameters:

$url:
  The URL for docker API

$tags:
  optional array of tags

$group:
  optional name of docker group to add dd-agent user too

Sample Usage:

class { 'datadog_agent::integrations::docker_daemon' :
  url           => 'unix://var/run/docker.sock',
}

Parameters:

  • group (String) (defaults to: 'docker')
  • docker_root (String) (defaults to: '/')
  • timeout (Integer) (defaults to: 10)
  • api_version (String) (defaults to: 'auto')
  • tls (Boolean) (defaults to: false)
  • tls_client_cert (String) (defaults to: '/path/to/client-cert.pem')
  • tls_client_key (String) (defaults to: '/path/to/client-key.pem')
  • tls_cacert (String) (defaults to: '/path/to/ca.pem')
  • tls_verify (Boolean) (defaults to: true)
  • init_retry_interval (Integer) (defaults to: 0)
  • init_retries (Integer) (defaults to: 0)
  • url (String) (defaults to: 'unix://var/run/docker.sock')
  • collect_events (Boolean) (defaults to: true)
  • filtered_event_types (Array) (defaults to: [])
  • collect_container_size (Boolean) (defaults to: false)
  • custom_cgroups (Boolean) (defaults to: false)
  • health_service_check_whitelist (Array) (defaults to: [])
  • collect_container_count (Boolean) (defaults to: false)
  • collect_volume_count (Boolean) (defaults to: false)
  • collect_images_stats (Boolean) (defaults to: false)
  • collect_image_size (Boolean) (defaults to: false)
  • collect_disk_stats (Boolean) (defaults to: false)
  • collect_exit_codes (Boolean) (defaults to: false)
  • exclude (Array) (defaults to: [])
  • include (Array) (defaults to: [])
  • tags (Array) (defaults to: [])
  • ecs_tags (Boolean) (defaults to: true)
  • performance_tags (Array) (defaults to: [])
  • container_tags (Array) (defaults to: [])
  • collect_labels_as_tags (Array) (defaults to: [])
  • event_attributes_as_tags (Array) (defaults to: []) 


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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
 
# File 'manifests/integrations/docker_daemon.pp', line 25

class datadog_agent::integrations::docker_daemon (
  String $group = 'docker',
  String $docker_root = '/',
  Integer $timeout = 10,
  String $api_version = 'auto',
  Boolean $tls = false,
  String $tls_client_cert = '/path/to/client-cert.pem',
  String $tls_client_key = '/path/to/client-key.pem',
  String$tls_cacert = '/path/to/ca.pem',
  Boolean $tls_verify = true,
  Integer $init_retry_interval = 0,
  Integer $init_retries = 0,
  String $url = 'unix://var/run/docker.sock',
  Boolean $collect_events = true,
  Array $filtered_event_types = [],
  Boolean $collect_container_size = false,
  Boolean $custom_cgroups = false,
  Array $health_service_check_whitelist = [],
  Boolean $collect_container_count = false,
  Boolean $collect_volume_count = false,
  Boolean $collect_images_stats = false,
  Boolean $collect_image_size = false,
  Boolean $collect_disk_stats = false,
  Boolean $collect_exit_codes = false,
  Array $exclude = [],
  Array $include = [],
  Array $tags = [],
  Boolean $ecs_tags = true,
  # Possible values: "container_name", "image_name", "image_tag", "docker_image"
  Array $performance_tags = [],
  # Possible values: "image_name", "image_tag", "docker_image"
  Array $container_tags = [],
  # Ex. "com.docker.compose.service", "com.docker.compose.project"
  Array $collect_labels_as_tags = [],
  Array $event_attributes_as_tags = [],
) inherits datadog_agent::params {
  require datadog_agent

  exec { 'dd-agent-should-be-in-docker-group':
    command => "/usr/sbin/usermod -aG ${group} ${datadog_agent::dd_user}",
    unless  => "/bin/cat /etc/group | grep '^${group}:' | grep -qw ${datadog_agent::dd_user}",
    require => Package[$datadog_agent::params::package_name],
    notify  => Service[$datadog_agent::params::service_name],
  }

  $dst_dir = "${datadog_agent::params::conf_dir}/docker.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_file,
    content => template('datadog_agent/agent-conf.d/docker_daemon.yaml.erb'),
    require => Package[$datadog_agent::params::package_name],
    notify  => Service[$datadog_agent::params::service_name],
  }
}