Wiki

Documentation

collectd's documentation consists primarily of the manpages that come with the daemon, accompanied with some special documents on certain aspects. A more generic source of information is the file README that's included in the source tarball. Also, some more specialized documentation, including a getting started guide, can be found below.

Manual pages

The manpages, that come with the daemon, are provided here in HTML form for your convenience. Since converting them to HTML format is not fully automatic they may be a little outdated here. If in doubt, please refer to the manpages that come with the distribution.

• collectd(1)
• collectdmon(1)
• collectd.conf(5)
• collectd-email(5)
• collectd-exec(5)
• collectd-nagios(1)
• collectd-perl(5)
• collectd-python(5)
• collectd-java(5)
• collectd-snmp(5)
• collectd-tg(1)
• collectd-unixsock(5)
• types.db(5)

collectd Wiki

In order to make it easier to contribute documentation, we have moved some of the documentation into a wiki. You can switch to the wiki (and back to the homepage) using the buttons in the upper right corner of the site. Or follow this link:

• collectd Wiki

Special documentation

The following documentation describes some special aspects of the daemon.

• First steps with collectd
• Networking introduction
• Inside the RRDtool plugin
• Notifications and thresholds
• Introduction to chains, collectd's filtering mechanism.
• collectd v3 to v4 migration guide
• General development information and documentation
• How to Report Bugs Effectively

Reference documentation

A lot of projects refer to their technical documentation under "reference documentation". If you're looking for that, please read the manual pages above. We provide links to specific parts of our documentation here.

Plugins

A list of all plugins, together with a short description for each, can be found in the README file included in the source code distribution.
There's also the Table of Plugins wiki page.

Libraries / Dependencies

A list of all supported libraries and which plugins make use of each library is documented in the README file under "Prerequisites".

Configuration options

All configuration options, both, for the server and for all plugins, are documented in collectd.conf(5).

Contributors

A list of all contributors can be found in the file AUTHORS included in the source code distribution.

Help writing documentation!

Writing documentation is, along with reporting bugs, an easy and very much appreciated way of contributing to an open source project. You can do this without any coding skills whats-o-ever and everybody will benefit from it - users and developers alike. If you have written something up, or plan to, let us know :)

External documentation

The following documentation has been found on the web or has been submitted by users.

• "Overview of the Monitoring System" in the RightScale wiki
• Entry "collectd" in the monitoring-fr.org wiki (french)