Merge branch 'collectd-4.5'

[collectd.git] / README

diff --git a/README b/README
index e698786..b6bdb41 100644 (file)
--- a/README
+++ b/README
@@ -40,6 +40,10 @@ Features
     - cpufreq
       CPU frequency (For laptops with speed step or a similar technology)
 
     - 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)
 
     - df
       Mountpoint usage (Basically the values `df(1)' delivers)
 


@@ -76,6 +80,9 @@ Features
       Iptables' counters: Number of bytes that were matched by a certain
       iptables rule.
 
       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).
     - ipvs
       IPVS connection statistics (number of connections, octets and packets
       for each service and destination).


@@ -152,9 +159,15 @@ Features
       PostgreSQL database statistics: active server connections, transaction
       numbers, block IO, table row manipulations.
 
       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.
 
     - 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.
     - sensors
       System sensors, accessed using lm_sensors: Voltages, temperatures and
       fan rotation speeds.


@@ -180,6 +193,12 @@ Features
     - tcpconns
       Number of TCP connections to specific local and remote ports.
 
     - 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.
 
     - users
       Users currently logged in.
 


@@ -214,6 +233,11 @@ Features
       you can easily do weird stuff with the plugins we didn't dare think of
       ;) See collectd-perl(5).
 
       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
     - rrdtool
       Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
       This is likely the most popular destination for such values. Since


@@ -279,7 +303,7 @@ Features
     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.
     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.
 
   * 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.
 


@@ -339,76 +363,101 @@ Prerequisites
   * CoreFoundation.framework and IOKit.framework (optional)
     For compiling on Darwin in general and the `apple_sensors' plugin in
     particular.
   * 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', `ascent', or `nginx' plugin.
 
   * libcurl (optional)
     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.
 
   * 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.
 
   * 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.
     For querying iptables counters.

+    <http://netfilter.org/>

 
   * libmysqlclient (optional)
     Unsurprisingly used by the `mysql' plugin.
 
   * libmysqlclient (optional)
     Unsurprisingly used by the `mysql' plugin.

+    <http://dev.mysql.com/>

 
   * libnetlink (optional)
     Used, obviously, for the `netlink' plugin.
 
   * libnetlink (optional)
     Used, obviously, for the `netlink' plugin.

+    <http://www.linuxfoundation.org/en/Net:Iproute2>

 
   * libnetsnmp (optional)
     For the `snmp' plugin.
 
   * libnetsnmp (optional)
     For the `snmp' plugin.

+    <http://www.net-snmp.org/>

 
   * libnotify (optional)
     For the `notify_desktop' plugin.
 
   * 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.
 
   * 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).
 
   * 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.
 
   * 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).
 
   * 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/>

 
   * libpq (optional)
     The PostgreSQL C client library used by the `postgresql' plugin.
 
   * libpq (optional)
     The PostgreSQL C client library used by the `postgresql' plugin.

+    <http://www.postgresql.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.
+  * 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.
 
   * 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.
 
   * libsensors (optional)
     To read from `lm_sensors', see the `sensors' plugin.

+    <http://www.lm-sensors.org/>

 
 

-  * libstatgrab (optional) 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'.
 
   * libupsclient/nut (optional)
     For the `nut' plugin which queries nut's `upsd'.

+    <http://networkupstools.org/>

 
   * libvirt (optional)
     Collect statistics from virtual machines.
 
   * libvirt (optional)
     Collect statistics from virtual machines.

+    <http://libvirt.org/>

 
   * libxml2 (optional)
     Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
 
   * libxml2 (optional)
     Parse XML data. This is needed for the `ascent' and `libvirt' plugins.

+    <http://xmlsoft.org/>

 
   * libxmms (optional)
 
   * libxmms (optional)

+    <http://www.xmms.org/>

 
 
 Configuring / Compiling / Installing
 
 
 Configuring / Compiling / Installing


@@ -418,7 +467,7 @@ 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'.
   `./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
   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