index 2a5502c2e534ee320fcec987d705610a0af7e501..97b66f7902a7d0d130623440b2e6b3f9950f3264 100644 (file)
--- a/README
+++ b/README
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.
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
- 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.
- 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/>.
- 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:
+
+ - 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
platforms.
* libcurl (optional)
- If you want to use the `apache' and/or `nginx' plugins.
+ If you want to use the `apache', `ascent', or `nginx' plugin.
+
+ * libhal (optional)
+ If present, the uuid plugin will check for UUID from HAL.
* libiptc (optional)
For querying iptables counters.
* libvirt (optional)
Collect statistics from virtual machines.
+ * libxml2 (optional)
+ Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
+
Configuring / Compiling / Installing
------------------------------------
disable all plugins whose requirements cannot be fulfilled (any other plugin
will be enabled). To enable a plugin, install missing dependencies (see
section `Prerequisites' above) and rerun `configure'. If you specify the
- `--enable-<plugin>' configure option, you can force the plugin to be built.
- This will most likely fail though unless you're working in a very unusual
- setup and you really know what you're doing.
+ `--enable-<plugin>' configure option, the script will fail if the depen-
+ dencies for the specified plugin are not met. If you specify the
+ `--disable-<plugin>' configure option, the plugin will not be built. Both
+ options are meant for package maintainers and should not be used in everyday
+ situations.
By default, collectd will be installed into `/opt/collectd'. You can adjust
this setting by specifying the `--prefix' configure option - see INSTALL for