Puppet Class: datadog_agent::integrations::kafka

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

Overview

Class: datadog_agent::integrations::kafka

This class will install the necessary configuration for the kafka integration

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

# See the metrics.yaml file for the list of default collected metrics. github.com/DataDog/integrations-core/blob/master/kafka/datadog_checks/kafka/data/metrics.yaml

This check has a limit of 350 metrics per instance. If you require additional metrics, contact Datadog Support at docs.datadoghq.com/help/

Parameters:

$host:
    The host kafka is running on. Defaults to 'localhost'
$username
    Optionally specify username for connection
$password
    Optionally specify password for connection
$port
    The port kafka is running on. Defaults to 9999
$name
    Name given to kafka instance
$process_name_regex
    Instead of specifying a host, and port. The agent can connect using the attach api.
$tools_jar_path
    Path to tools jar needs to be set when process_name_regex is set
$java_bin_path
    Path to java binary, should be set if agent cant find your java executable
$trust_store_path
    Path to the trust store, should be set if ssl is enabled
$trust_store_password
    Password to the trust store
$tags
    Optional array of tags

Sample Usage:

class { 'datadog_agent::integrations::kafka' :
  servers => [
    {
      'host'                 => 'localhost',
      'username'             => 'kafka_username',
      'password'             => 'kafka_password',
      'port'                 => '9999',
      'name'                 => 'kafka_instance',
      'process_name_regex'   => '.*process_name.*',
      'tools_jar_path'       => '/usr/lib/jvm/java-7-openjdk-amd64/lib/tools.jar',
      'java_bin_path'        => '/path/to/java',
      'trust_store_path'     => '/path/to/trustStore.jks',
      'trust_store_password' => 'password',
      'tags'                 => ['env: test', 'sometag: someinfo'],
    },
    {
      'host' => 'localhost',
      'port' => '9999',
      'tags' => [],
    },
  ]
}

Parameters:

  • host (String) (defaults to: 'localhost')
  • port (Variant[String[1], Integer]) (defaults to: 9999)
  • username (Optional[String[1]]) (defaults to: undef)
  • password (Optional[String[1]]) (defaults to: undef)
  • process_name_regex (Optional[String[1]]) (defaults to: undef)
  • tools_jar_path (Optional[String[1]]) (defaults to: undef)
  • java_bin_path (Optional[String[1]]) (defaults to: undef)
  • trust_store_path (Optional[String[1]]) (defaults to: undef)
  • trust_store_password (Optional[String[1]]) (defaults to: undef)
  • tags (Optional[Hash[String[1], String[1]]]) (defaults to: undef)
  • instances (Optional[Array[Hash[String[1], Data]]]) (defaults to: undef) 


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
115
116
117
118
119
 
# File 'manifests/integrations/kafka.pp', line 64

class datadog_agent::integrations::kafka (
  String $host                                      = 'localhost',
  Variant[String[1], Integer] $port                 = 9999,
  Optional[String[1]] $username                     = undef,
  Optional[String[1]] $password                     = undef,
  Optional[String[1]] $process_name_regex           = undef,
  Optional[String[1]] $tools_jar_path               = undef,
  Optional[String[1]] $java_bin_path                = undef,
  Optional[String[1]] $trust_store_path             = undef,
  Optional[String[1]] $trust_store_password         = undef,
  Optional[Hash[String[1], String[1]]] $tags        = undef,
  Optional[Array[Hash[String[1], Data]]] $instances = undef,
) inherits datadog_agent::params {
  require datadog_agent

  if !$instances and $host and $port {
    $servers = [{
        'host'                 => $host,
        'port'                 => $port,
        'username'             => $username,
        'password'             => $password,
        'process_name_regex'   => $process_name_regex,
        'tools_jar_path'       => $tools_jar_path,
        'java_bin_path'        => $java_bin_path,
        'trust_store_path'     => $trust_store_path,
        'trust_store_password' => $trust_store_password,
        'tags'                 => $tags,
    }]
  } elsif !$instances {
    $servers = []
  } else {
    $servers = $instances
  }

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