X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=904e7c73a7692ed327a05418f211595e30d73cc9;hb=3f2f61c7d74d9204405a4b0c21390451c98665a7;hp=2a5502c2e534ee320fcec987d705610a0af7e501;hpb=c88e459eb3823b766fc3a9ed37f25bc1f630146c;p=collectd.git diff --git a/README b/README index 2a5502c2..904e7c73 100644 --- a/README +++ b/README @@ -5,8 +5,9 @@ http://collectd.org/ 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 @@ -25,6 +26,9 @@ 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. @@ -121,7 +125,7 @@ Features 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 @@ -155,6 +159,10 @@ Features - 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. @@ -164,6 +172,10 @@ Features - 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 . @@ -209,9 +221,36 @@ Features - 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 @@ -277,7 +316,10 @@ Prerequisites 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. @@ -331,6 +373,9 @@ Prerequisites * libvirt (optional) Collect statistics from virtual machines. + * libxml2 (optional) + Parse XML data. This is needed for the `ascent' and `libvirt' plugins. + Configuring / Compiling / Installing ------------------------------------