Merge branch 'collectd-4.2' into collectd-4.3

[collectd.git] / README

diff --git a/README b/README
index 2a5502c..8c0be1d 100644 (file)
--- 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
@@ -121,7 +122,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
@@ -209,9 +210,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
@@ -279,6 +307,9 @@ Prerequisites
   * libcurl (optional)
     If you want to use the `apache' and/or `nginx' plugins.
 
+  * libhal (optional)
+    If present, the uuid plugin will check for UUID from HAL.
+
   * libiptc (optional)
     For querying iptables counters.
 
@@ -331,6 +362,9 @@ Prerequisites
   * libvirt (optional)
     Collect statistics from virtual machines.
 
+  * libxml2 (optional)
+    Parse XML data provided by libvirt.
+
 
 Configuring / Compiling / Installing
 ------------------------------------