Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

collectd

Puppet module for collectd
Project URLRSS FeedReport issues

12,740 downloads

8,037 latest version

4.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 3.0.8 (latest)
  • 3.0.7
  • 3.0.6
  • 3.0.5
  • 3.0.4
  • 3.0.3
released Oct 19th 2015
This module has been deprecated by its author since Oct 28th 2019.

The reason given was: No longer maintained

The author has suggested puppet-collectd as its replacement.

Start using this module

Tags: collectd, monitoring, example42, stdmod

Documentation

example42/collectd — version 3.0.8 Oct 19th 2015

#collectd

DEPRECATION NOTICE

This module is no more actively maintained and will hardly be updated.

Please find an alternative module from other authors or consider Tiny Puppet as replacement.

If you want to maintain this module, contact Alessandro Franceschi

####Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Operating Systems Support
  6. Development

##Overview

This module installs, manages and configures collectd.

##Module Description

The module is based on stdmod naming standards version 0.9.0.

Refer to http://github.com/stdmod/ for complete documentation on the common parameters.

##Setup

###Resources managed by collectd module

  • This module installs the collectd package
  • Enables the collectd service
  • Can manage all the configuration files (by default no file is changed)
  • Can install and configure collectd plugins

###Setup Requirements

###Beginning with module collectd

To install the package provided by the module just include it:

    include collectd

The main class arguments can be provided either via Hiera (from Puppet 3.x) or direct parameters:

    class { 'collectd':
      parameter => value,
    }

The module provides also a generic define to manage any collectd configuration file:

    collectd::conf { 'sample.conf':
      content => '# Test',
    }

You can place the configurations of a plugin either in the main config file or in a file managed with the generic define collect::conf or with the dedicated define collectd::plugin (which can also install the relevant package):

    collectd::plugin { 'mysql':
      config_file_template     => 'site/collectd/plugin/mysql.erb',
      config_file_options_hash => {
        host     => 'localhost',
        user     => 'wordpress',
        password => 'secret',
        database => 'wordpress',
      },
      package_install          => true,  # Default: false
    }

A custom plugin template is available as well:

      collectd::plugin { 'rrdtool':
        config_file_options_hash => {
          'DataDir'         => '"/var/lib/collectd/"',
          'RRARows'         => '1337',
          'RRATimespan'     => [ '10',
                                 '100',
                                 '1000' ],
          'XFF'             => '0.25',
        }
      }

This results in:

##Usage

  • A common way to use this module involves the management of the main configuration file via a custom template (provided in a custom site module):

      class { 'collectd':
    config_file_template => 'site/collectd/collectd.conf.erb',
  }

  • You can write custom templates that use setting provided but the config_file_options_hash paramenter

      class { 'collectd':
    config_file_template      => 'site/collectd/collectd.conf.erb',
    config_file_options_hash  => {
      opt  => 'value',
      opt2 => 'value2',
    },
  }

  • Use custom source (here an array) for main configuration file. Note that template and source arguments are alternative.

      class { 'collectd':
    config_file_source => [ "puppet:///modules/site/collectd/collectd.conf-${hostname}" ,
                            "puppet:///modules/site/collectd/collectd.conf" ],
  }

  • You can provide a custom template (or content or source) also for the init configuration script for which eventually use a dedicated config hash with init_config_file_options_hash paramenter

      class { 'collectd':
    init_config_file_template      => 'site/collectd/collectd.init.erb',
    init_config_file_options_hash  => {
      opt  => 'value',
      opt2 => 'value2',
    },
  }

  • Use custom source directory for the whole configuration directory, where present.

      class { 'collectd':
    config_dir_source  => 'puppet:///modules/site/collectd/conf/',
  }

  • Use custom source directory for the whole config.d directory (on RedHat family config_dir_path == confd_dir_path).

      class { 'collectd':
    confd_dir_source  => 'puppet:///modules/site/collectd/collectd.d',
  }

  • Use custom source directory for the whole configuration directory and purge all the local files that are not on the dir. Note: This option can be used to be sure that the content of a directory is exactly the same you expect, but it is desctructive and may remove files.

      class { 'collectd':
    config_dir_source => 'puppet:///modules/site/collectd/conf/',
    config_dir_purge  => true, # Default: false.
  }

  • Use custom source directory for the whole configuration dir and define recursing policy.

      class { 'collectd':
    config_dir_source    => 'puppet:///modules/site/collectd/conf/',
    config_dir_recursion => false, # Default: true.
  }

  • Do not trigger a service restart when a config file changes.

      class { 'collectd':
    config_dir_notify => '', # Default: Service[collectd]
  }

##Operating Systems Support

This is tested on these OS:

  • RedHat osfamily 5 and 6
  • Debian 6 and 7
  • Ubuntu 10.04 and 12.04

##Development

Pull requests (PR) and bug reports via GitHub are welcomed.

When submitting PR please follow these quidelines:

  • Provide puppet-lint compliant code
  • If possible provide rspec tests
  • Follow the module style and stdmod naming standards

When submitting bug report please include or link:

  • The Puppet code that triggers the error
  • The output of facter on the system where you try it
  • All the relevant error logs
  • Any other information useful to undestand the context