About
-----
- collectd is a small daemon which collects statistics about a computer's
- usage and writes then into RRD files.
+ collectd is a small daemon which collects system information periodically
+ and provides mechanisms to store and monitor the values in a variety of
+ ways.
Features
Sensors in Macs running Mac OS X / Darwin: Temperature, fanspeed and
voltage sensors.
+ - ascent
+ Statistics about Ascent, a free server for the game `World of Warcraft'.
+
- battery
Batterycharge, -current and voltage of ACPI and PMU based laptop
batteries.
- cpufreq
CPU frequency (For laptops with speed step or a similar technology)
+ - dbi
+ Executes SQL statements on various databases and interprets the returned
+ data.
+
- df
Mountpoint usage (Basically the values `df(1)' delivers)
Values gathered by a custom program or script.
See collectd-exec(5).
+ - filecount
+ Count the number of files in directories.
+
- hddtemp
Harddisk temperatures using hddtempd.
Iptables' counters: Number of bytes that were matched by a certain
iptables rule.
+ - ipmi
+ IPMI (Intelligent Platform Management Interface) sensors information.
+
- ipvs
IPVS connection statistics (number of connections, octets and packets
for each service and destination).
- load
System load average over the last 1, 5 and 15 minutes.
+ - libvirt
+ CPU, disk and network I/O statistics from virtual machines.
+
- mbmon
Motherboard sensors: temperature, fanspeed and voltage information,
using mbmon(1).
Collects statistics from `nginx' (speak: engine X), a HTTP and mail
server/proxy.
- - ntp
+ - ntpd
NTP daemon statistics: Local clock drift, offset to peers, etc.
- nut
Network UPS tools: UPS current, voltage, power, charge, utilisation,
temperature, etc. See upsd(8).
+ - onewire (EXPERIMENTAL!)
+ Read onewire sensors using the owcapu library of the owfs project.
+ Please read in collectd.conf(5) why this plugin is experimental.
+
- perl
The perl plugin implements a Perl-interpreter into collectd. You can
write your own plugins in Perl and return arbitrary values using this
API. See collectd-perl(5).
- This plugin is still considered to be experimental and subject to change
- between minor releases.
-
- ping
Network latency: Time to reach the default gateway or another given
host.
+ - postgresql
+ PostgreSQL database statistics: active server connections, transaction
+ numbers, block IO, table row manipulations.
+
+ - powerdns
+ PowerDNS name server statistics.
+
- processes
Process counts: Number of running, sleeping, zombie, ... processes.
+ - rrdcached
+ RRDtool caching daemon (RRDcacheD) statistics.
+
- sensors
System sensors, accessed using lm_sensors: Voltages, temperatures and
fan rotation speeds.
- swap
Pages swapped out onto harddisk or whatever is called `swap' by the OS..
+ - tail
+ Follows (tails) logfiles, parses them by lines and submits matched
+ values.
+
- tape
Bytes and operations read and written on tape devices. Solaris only.
- tcpconns
Number of TCP connections to specific local and remote ports.
+ - teamspeak2
+ TeamSpeak2 server statistics.
+
+ - thermal
+ Linux ACPI thermal zone information.
+
- users
Users currently logged in.
+ - vmem
+ Virtual memory statistics, e. g. the number of page-ins/-outs or the
+ number of pagefaults.
+
- vserver
System resources used by Linux VServers.
See <http://linux-vserver.org/>.
you can easily do weird stuff with the plugins we didn't dare think of
;) See collectd-perl(5).
+ - rrdcached
+ Output to round-robin-database (RRD) files using the RRDtool caching
+ daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
+ implementation of the caching done by the `rrdtool' plugin.
+
- rrdtool
Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
This is likely the most popular destination for such values. Since
- logfile
Writes logmessages to a file or STDOUT/STDERR.
+ - perl
+ Log messages are propagated to plugins written in Perl as well.
+ See collectd-perl(5).
+
- syslog
Logs to the standard UNIX logging mechanism, syslog.
+ * Notifications can be handled by the following plugins:
+
+ - notify_desktop
+ Send a desktop notification to a notification daemon, as defined in
+ the Desktop Notification Specification. To actually display the
+ notifications, notification-daemon is required.
+ See http://www.galago-project.org/specs/notification/.
+
+ - notify_email
+ Send an E-mail with the notification message to the configured
+ recipients.
+
+ - exec
+ Execute a program or script to handle the notification.
+ See collectd-exec(5).
+
+ - logfile
+ Writes the notification message to a file or STDOUT/STDERR.
+
+ - network
+ Send the notification to a remote host to handle it somehow.
+
+ - perl
+ Notifications are propagated to plugins written in Perl as well.
+ See collectd-perl(5).
+
+ * Miscellaneous plugins:
+
+ - uuid
+ Sets the hostname to an unique identifier. This is meant for setups
+ where each client may migrate to another physical host, possibly going
+ through one or more name changes in the process.
+
* Performance: Since collectd is running as a daemon it doesn't spend much
time starting up again and again. With the exception of the exec plugin no
processes are forked. Caching in output plugins, such as the rrdtool and
since collectd is programmed multithreaded it benefits from hyperthreading
and multicore processors and makes sure that the daemon isn't idle if only
one plugins waits for an IO-operation to complete.
-
+
* Once set up, hardly any maintenance is necessary. Setup is kept as easy
as possible and the default values should be okay for most users.
used and should be found in various implementations for hopefully all
platforms.
+ * CoreFoundation.framework and IOKit.framework (optional)
+ For compiling on Darwin in general and the `apple_sensors' plugin in
+ particular.
+ <http://developer.apple.com/corefoundation/>
+
* libcurl (optional)
- If you want to use the `apache' and/or `nginx' plugins.
+ If you want to use the `apache', `ascent', or `nginx' plugin.
+ <http://curl.haxx.se/>
+
+ * libdbi (optional)
+ Used by the `dbi' plugin to connect to various databases.
+ <http://libdbi.sourceforge.net/>
+
+ * libesmtp (optional)
+ For the `notify_email' plugin.
+ <http://www.stafford.uklinux.net/libesmtp/>
+
+ * libhal (optional)
+ If present, the uuid plugin will check for UUID from HAL.
+ <http://hal.freedesktop.org/>
- * libiptc (optional)
+ * libiptc (optional, if not found a version shipped with this distribution
+ can be used if the Linux kernel headers are available)
For querying iptables counters.
+ <http://netfilter.org/>
* libmysqlclient (optional)
Unsurprisingly used by the `mysql' plugin.
+ <http://dev.mysql.com/>
* libnetlink (optional)
Used, obviously, for the `netlink' plugin.
+ <http://www.linuxfoundation.org/en/Net:Iproute2>
* libnetsnmp (optional)
For the `snmp' plugin.
+ <http://www.net-snmp.org/>
+
+ * libnotify (optional)
+ For the `notify_desktop' plugin.
+ <http://www.galago-project.org/>
* liboping (optional, if not found a version shipped with this distribution
can be used)
Used by the `ping' plugin to send and receive ICMP packets.
+ <http://verplant.org/liboping/>
+
+ * libowcapi (optional)
+ Used by the `onewire' plugin to read values from onewire sensors (or the
+ owserver(1) daemon).
+ <http://www.owfs.org/>
* libpcap (optional)
Used to capture packets by the `dns' plugin.
+ <http://www.tcpdump.org/>
+
+ * libperl (optional)
+ Obviously used by the `perl' plugin. The library has to be compiled with
+ ithread support (introduced in Perl 5.6.0).
+ <http://www.perl.org/>
- * librrd (optional; headers and library; rrdtool 1.0 and 1.2 both work fine)
- If built without `librrd' the resulting binary will be `client only', i.e.
- will send its values via multicast and not create any RRD files itself.
- Alternatively you can chose to write CSV-files (Comma Separated Values)
- instead.
+ * libpq (optional)
+ The PostgreSQL C client library used by the `postgresql' plugin.
+ <http://www.postgresql.org/>
+
+ * librrd (optional)
+ Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
+ client support which was added after version 1.3 of RRDtool. Versions 1.0,
+ 1.2 and 1.3 are known to work with the `rrdtool' plugin.
+ <http://oss.oetiker.ch/rrdtool/>
+
+ * librt, libsocket, libkstat, libdevinfo (optional)
+ Various standard Solaris libraries which provide system functions.
+ <http://developers.sun.com/solaris/>
* libsensors (optional)
To read from `lm_sensors', see the `sensors' plugin.
+ <http://www.lm-sensors.org/>
- * libstatgrab may be used to collect statistics on systems other than Linux
- and/or Solaris. Note that CPU- and disk-statistics, while being provided
- by this library, are not supported in collectd right now..
- <http://www.i-scream.org/libstatgrab/>
+ * libstatgrab (optional)
+ Used by various plugins to collect statistics on systems other than Linux
+ and/or Solaris.
+ <http://www.i-scream.org/libstatgrab/>
* libupsclient/nut (optional)
For the `nut' plugin which queries nut's `upsd'.
+ <http://networkupstools.org/>
- * libxmms (optional)
+ * libvirt (optional)
+ Collect statistics from virtual machines.
+ <http://libvirt.org/>
- * librt, libsocket, libkstat, libdevinfo
- Various standard Solaris libraries which provide system functions.
+ * libxml2 (optional)
+ Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
+ <http://xmlsoft.org/>
- * CoreFoundation.framework and IOKit.framework
- For compiling on Darwin in general and the `apple_sensors' plugin in
- particular.
+ * libxmms (optional)
+ <http://www.xmms.org/>
Configuring / Compiling / Installing
`./configure && make && make install'. For detailed, generic instructions
see INSTALL. For a complete list of configure options and their description,
run `./configure --help'.
-
+
By default, the configure script will check for all build dependencies and
disable all plugins whose requirements cannot be fulfilled (any other plugin
will be enabled). To enable a plugin, install missing dependencies (see
projects / collectd.git / blobdiff