bindings/java/: JMXMemory: Add GPL and copyright header.

[collectd.git] / README

diff --git a/README b/README
index 97b66f7..a0ce764 100644 (file)
--- a/README
+++ b/README
@@ -33,6 +33,13 @@ Features
       Batterycharge, -current and voltage of ACPI and PMU based laptop
       batteries.
 
       Batterycharge, -current and voltage of ACPI and PMU based laptop
       batteries.
 

+    - curl
+      Parse statistics from websites using regular expressions.
+
+    - bind
+      Name server and resolver statistics from the `statistics-channel'
+      interface of BIND 9.5, 9,6 and later.
+

     - cpu
       CPU utilization: Time spent in the system, user, nice, idle, and related
       states.
     - cpu
       CPU utilization: Time spent in the system, user, nice, idle, and related
       states.


@@ -40,6 +47,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)
 


@@ -62,6 +73,12 @@ Features
       Values gathered by a custom program or script.
       See collectd-exec(5).
 
       Values gathered by a custom program or script.
       See collectd-exec(5).
 

+    - filecount
+      Count the number of files in directories.
+
+    - gmond
+      Receive multicast traffic from Ganglia instances.
+

     - hddtemp
       Harddisk temperatures using hddtempd.
 
     - hddtemp
       Harddisk temperatures using hddtempd.
 


@@ -73,6 +90,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).


@@ -132,6 +152,17 @@ Features
       Network UPS tools: UPS current, voltage, power, charge, utilisation,
       temperature, etc. See upsd(8).
 
       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.
+
+    - openvpn
+      RX and TX of each client in openvpn-status.log (status-version 2).
+      <http://openvpn.net/index.php/documentation/howto.html>
+
+    - oracle
+      Query data from an Oracle database.
+

     - perl
       The perl plugin implements a Perl-interpreter into collectd. You can
       write your own plugins in Perl and return arbitrary values using this
     - perl
       The perl plugin implements a Perl-interpreter into collectd. You can
       write your own plugins in Perl and return arbitrary values using this


@@ -141,9 +172,22 @@ Features
       Network latency: Time to reach the default gateway or another given
       host.
 
       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.
 
     - processes
       Process counts: Number of running, sleeping, zombie, ... processes.
 

+    - protocols
+      Counts various aspects of network protocols such as IP, TCP, UDP, etc.
+
+    - 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.


@@ -169,6 +213,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.
 


@@ -203,6 +253,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


@@ -230,6 +285,16 @@ Features
 
   * Notifications can be handled by the following plugins:
 
 
   * 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).
     - exec
       Execute a program or script to handle the notification.
       See collectd-exec(5).


@@ -244,6 +309,27 @@ Features
       Notifications are propagated to plugins written in Perl as well.
       See collectd-perl(5).
 
       Notifications are propagated to plugins written in Perl as well.
       See collectd-perl(5).
 

+  * Value processing can be controlled using the "filter chain" infrastructure
+    and "matches" and "targets". The following plugins are available:
+
+    - match_regex
+      Match values by their identifier based on regular expressions.
+
+    - match_timediff
+      Match values with an invalid timestamp.
+
+    - match_value
+      Select values by their data sources' values.
+
+    - target_notification
+      Create and dispatch a notification.
+
+    - target_replace
+      Replace parts of an identifier using regular expressions.
+
+    - target_set
+      Set (overwrite) entire parts of an identifier.
+

   * Miscellaneous plugins:
 
     - uuid
   * Miscellaneous plugins:
 
     - uuid


@@ -258,7 +344,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.
 


@@ -315,66 +401,107 @@ Prerequisites
     used and should be found in various implementations for hopefully all
     platforms.
 
     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/>
+
+  * libclntsh (optional)
+    Used by the `oracle' plugin.
+

   * libcurl (optional)
   * libcurl (optional)

-    If you want to use the `apache', `ascent', or `nginx' plugin.
+    If you want to use the `apache', `ascent', `curl' 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.
 
   * 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.
+    <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).
+    <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/>

 
 

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

-
-  * libxmms (optional)
-
-  * librt, libsocket, libkstat, libdevinfo
-    Various standard Solaris libraries which provide system functions.
-
-  * CoreFoundation.framework and IOKit.framework
-    For compiling on Darwin in general and the `apple_sensors' plugin in
-    particular.
+    <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)
+    <http://www.xmms.org/>

 
 
 Configuring / Compiling / Installing
 
 
 Configuring / Compiling / Installing


@@ -384,7 +511,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


@@ -420,12 +547,24 @@ Crosscompiling
   that the compiled binary actually behaves as it should, but since NANs
   are likely never passed to the libm you have a good chance to be lucky.
 
   that the compiled binary actually behaves as it should, but since NANs
   are likely never passed to the libm you have a good chance to be lucky.
 

+  Likewise, collectd needs to know the layout of doubles in memory, in order
+  to craft uniform network packets over different architectures. For this, it
+  needs to know how to convert doubles into the memory layout used by x86. The
+  configure script tries to figure this out by compiling and running a few
+  small test programs. This is of course not possible when cross-compiling.
+  You can use the `--with-fp-layout' option to tell the configure script which
+  conversion method to assume. Valid arguments are:
+
+    * `nothing'    (12345678 -> 12345678)
+    * `endianflip' (12345678 -> 87654321)
+    * `intswap'    (12345678 -> 56781234)
+

 
 Contact
 -------
 
 
 Contact
 -------
 

-  For questions, bugreports, development information and basically all other
-  concerns please send an email to collectd's mailinglist at
+  For questions, bug reports, development information and basically all other
+  concerns please send an email to collectd's mailing list at

   <collectd at verplant.org>.
 
   For live discussion and more personal contact visit us in IRC, we're in
   <collectd at verplant.org>.
 
   For live discussion and more personal contact visit us in IRC, we're in


@@ -439,5 +578,6 @@ Author
   Sebastian tokkee Harl <sh at tokkee.org>,
   and many contributors (see `AUTHORS').
 
   Sebastian tokkee Harl <sh at tokkee.org>,
   and many contributors (see `AUTHORS').
 

-  Please send bugreports and patches to the mailinglist, see `Contact' above.
+  Please send bug reports and patches to the mailing list, see `Contact'
+  above.