Puppet Class: puppet_statsd

Defined in:
modules/puppet_statsd/manifests/init.pp

Overview

SPDX-License-Identifier: Apache-2.0

Class: puppet_statsd

This module configures a Puppet reporter that sends timing information on Puppet runs to StatsD.

Parameters

statsd_host

StatsD host to send metrics to.

statsd_port

Port on which StatsD host is listening (default: 8125).

metric_format

ERB Template string for metric names; the variables 'hostname' and 'metric' will be set in template scope to the local hostname and the metric name, respectively. Default: 'puppet.<%= metric %>.<%= hostname %>'.

Examples

To enable, enable pluginsync and reports on your master and clients in puppet.conf:

[master]
report = true
reports = statsd
pluginsync = true

[agent]
report = true
pluginsync = true

..and include the class:

class { 'puppet_statsd':
  statsd_host => 'statsd.eqiad.wmnet',
}

Parameters:

  • statsd_host (Any)
  • statsd_port (Any) (defaults to: 8125)
  • metric_format (Any) (defaults to: 'puppet.<%= metric %>.<%= hostname %>') 


40
41
42
43
44
45
46
47
48
 
# File 'modules/puppet_statsd/manifests/init.pp', line 40

class puppet_statsd(
    $statsd_host,
    $statsd_port   = 8125,
    $metric_format = 'puppet.<%= metric %>.<%= hostname %>'
) {
    file { "${::puppet_config_dir}/statsd.yaml":
        content => template('puppet_statsd/statsd.yaml.erb'),
    }
}