collectd-formula

Travis CI Build Status Documentation Status Semantic Release

A SaltStack formula that installs and configures collectd. The system statistics collection daemon. start on a new formula and it serves as a style guide.

1. General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

2. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

3. Available states

4. collectd

Meta-state (This is a state that includes other states).

Installs the collectd package, and starts the associated collectd service.

4.1. collectd.service

Metastate used to include service into respective plugin states, included in collectd state.

4.2. collectd.apache

Enables and configures the [apache](https://collectd.org/wiki/index.php/Plugin:Apache) plugin. All common parameters are supported, so pass something like :

apache:
  instances:
    - name: 'human-readable-name'
      url: 'http://localhost/server-status?auto'
      user: 'user'
      pass: 'your-password'

Only name and url are required.

4.3. collectd.bind

Enables and configures the bind plugin.

4.4. collectd.dbi

Enables and configures the dbi plugin. It’s used for quering databases with libdbi. Refer to collectd.conf(5) manpage for details and pillar.example to see how values should be populated.

Beware this plugin may need additional packages installed on your system to run properly.

4.5. collectd.csv

Enables and configures the csv write plugin.

4.6. collectd.df

Enables and configures the df plugin.

4.7. collectd.disk

Enables and configures the disk plugin.

4.8. collectd.elasticsearch

Enables and configures the elasticsearch plugin

4.9. collectd.ethstat

Enables and configures the ethstat plugin (please note there is a possible bug in the debian package).

4.10. collectd.interface

Enables and configures the interface plugin.

4.11. collectd.java

Enables and configures the java plugin. If enabled it will also collect tomcat catalina metrics.

Requires the installation of JDK.

Pillar values used under collectd.plugins.java, an example :

collectd:
  plugins:
    java:
      host: localhost
      port: 39999
      user: 'someuser' (optional)
      group: 'someuser' (optional)
      lib: '/some/file' (optional)
      tomcat: true (optional)

4.12. collectd.logfile

Enables and configures the logfile plugin.

4.13. collectd.modules

This state helps distributing collectd external modules written in various languages (see [python](https://collectd.org/wiki/index.php/Plugin:Python) or [perl](https://collectd.org/wiki/index.php/Plugin:Perl) for example).

Sample usage:

  • Include collectd.modules in your topfile.

  • Create collectd/modules/files folder in your states.

  • Put modules you need in that folder.

  • Modules will be put in collectd.moduledirconfig folder.

4.14. collectd.mysql

Enables and configures the mysql plugin. Needs refinement.

4.15. collectd.network

Enables and configures the network plugin.

4.16. collectd.ntpd

Enables and configures the ntpd plugin.

4.17. collectd.packages

This state is used to install OS packages collectd plugins depend on.

4.18. collectd.postgresql

Enables and configures the postgresql plugin. Needs refinement.

4.19. collectd.processes

Enables and configures the processes plugin

4.20. collectd.protocols

Enables and configures the protocols plugin

4.21. collectd.powerdns

Enables and configures the powerdns plugin.

4.22. collectd.redis

Enables and configures the redis plugin.

4.23. collectd.syslog

Enables and configures the syslog plugin.

4.24. collectd.tail

Enables and configures the tail plugin.

4.25. collectd.tcpconns

Enables and configures the tcpconns plugin.

4.26. collectd.types

Manages a TypesDB file stored at plugindirconfig/types.db.

4.27. collectd.curl_json

Enables and configures the curl_json plugin.

4.28. collectd.curl_xml

Enables and configures the curl_xml plugin.

4.29. collectd.python

Enables and configures the python plugin, which allows executiong arbitrary python scripts.

4.30. collectd.vmem

Enables and configures the vmem plugin.

4.31. collectd.librato

Enables and configures write_http plugin for reporting to Librato

4.32. collectd.zookeeper

Enables and configures the zookeeper plugin.

4.33. collectd.unixsock

Enables and configures the unixsock plugin.

5. Usage

5.1. Custom state file

Create a custom state file (for example collectd-custom.sls) that includes the plugins you want and the base state. :

include:
  - collectd
  - collectd.disk
  - collectd.syslog

Then in your topfile: :

'servername':
  - collectd-custom

5.2. Directly in topfile

Or if you don’t mind having long lists in your topfile, just add whatever plugins you want and the base state. :

'servername':
  - collectd
  - collectd.disk
  - collectd.syslog

5.3. Combined

Or you can combine both - default plugins in custom state and specific in topfile. :

'apache-server':
  - collectd-custom
  - collectd.apache