Puppet Class: datadog_agent::integrations::tcp_check

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

Overview

Class: datadog_agent::integrations::tcp_check

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

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

Parameters:

check_name
    (Required) - Name of the service.
     This will be included as a tag: instance:<check_name>.

host
    (Required) - Host to be checked.
     This will be included as a tag: url:<host>:<port>.

port
    (Required) - Port to be checked.
     This will be included as a tag: url:<host>:<port>.

timeout
    (Optional) - Timeout for the check. Defaults to 10 seconds.

threshold
    (Optional) - Used in conjunction with window. An alert will
     trigger if the check fails <threshold> times in <window> attempts.

window
    (Optional) - Refer to threshold.

collect_response_time
    (Optional) - Defaults to false. If this is not set to true, no
    response time metric will be collected. If it is set to true, the
    metric returned is network.tcp.response_time.

tags
    The (optional) tags to add to the check instance.

Sample Usage:

Add a class for each check instance:

class { ‘datadog_agent::integrations::tcp_check’:

check_name => 'localhost-ftp',
host       => 'ftp.example.com',
port       => '21',

}

class { ‘datadog_agent::integrations::tcp_check’:

check_name => 'localhost-ssh',
host       => '127.0.0.1',
port       => '22',
threshold  => 1,
window     => 1,
tags       => ['production', 'ssh access'],

}

class { ‘datadog_agent::integrations::tcp_check’:

name                  => 'localhost-web-response',
host                  => '127.0.0.1',
port                  => '80',
timeout               => '8',
threshold             => 1,
window                => 1,
collect_response_time => true,
tags                  => ['production', 'webserver response time'],

}

Add multiple instances in one class declaration:

class { 'datadog_agent::integrations::tcp_check':
      instances => [{
        'check_name' => 'www.example.com-http',
        'host'       => 'www.example.com',
        'port'       => '80',
      },
      {
        'check_name' => 'www.example.com-https',
        'host'       => 'www.example.com',
        'port'       => '443',
      }]
   }

Parameters:

  • check_name (String)
  • host (String)
  • port (String)
  • timeout (Integer) (defaults to: 10)
  • threshold (Optional[Integer]) (defaults to: undef)
  • window (Optional[Integer]) (defaults to: undef)
  • collect_response_time (Boolean) (defaults to: false)
  • tags (Array) (defaults to: [])
  • instances (Optional[Array]) (defaults to: undef) 


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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'manifests/integrations/tcp_check.pp', line 83

class datadog_agent::integrations::tcp_check (
  String $check_name,
  String $host,
  String $port,
  Integer $timeout                  = 10,
  Optional[Integer] $threshold      = undef,
  Optional[Integer] $window         = undef,
  Boolean $collect_response_time    = false,
  Array $tags                       = [],
  Optional[Array] $instances        = undef,
) inherits datadog_agent::params {
  require datadog_agent

  if !$instances and $host {
    $_instances = [{
        'check_name'            => $check_name,
        'host'                  => $host,
        'port'                  => $port,
        'timeout'               => $timeout,
        'threshold'             => $threshold,
        'window'                => $window,
        'collect_response_time' => $collect_response_time,
        'tags'                  => $tags,
    }]
  } elsif !$instances {
    $_instances = []
  } else {
    $_instances = $instances
  }

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