Bump version to 4.9.4; Update ChangeLog.

[collectd.git] / README

diff --git a/README b/README
index ee7163c..2cb0a6f 100644 (file)
--- a/README
+++ b/README
@@ -33,9 +33,6 @@ 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.
     - bind
       Name server and resolver statistics from the `statistics-channel'
       interface of BIND 9.5, 9,6 and later.


@@ -43,6 +40,9 @@ Features
     - conntrack
       Number of nf_conntrack entries.
 
     - conntrack
       Number of nf_conntrack entries.
 

+    - contextswitch
+      Number of context switches done by the operating system.
+

     - 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.


@@ -50,6 +50,13 @@ 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)
 

+    - curl
+      Parse statistics from websites using regular expressions.
+
+    - curl_json
+      Retrieves JSON data via cURL and parses it according to user
+      configuration.
+

     - dbi
       Executes SQL statements on various databases and interprets the returned
       data.
     - dbi
       Executes SQL statements on various databases and interprets the returned
       data.


@@ -117,6 +124,10 @@ Features
     - libvirt
       CPU, disk and network I/O statistics from virtual machines.
 
     - libvirt
       CPU, disk and network I/O statistics from virtual machines.
 

+    - madwifi
+      Queries very detailed usage statistics from wireless LAN adapters and
+      interfaces that use the Atheros chipset and the MadWifi driver.
+

     - mbmon
       Motherboard sensors: temperature, fanspeed and voltage information,
       using mbmon(1).
     - mbmon
       Motherboard sensors: temperature, fanspeed and voltage information,
       using mbmon(1).


@@ -140,6 +151,10 @@ Features
       MySQL server statistics: Commands issued, handlers triggered, thread
       usage, query cache utilization and traffic/octets sent and received.
 
       MySQL server statistics: Commands issued, handlers triggered, thread
       usage, query cache utilization and traffic/octets sent and received.
 

+    - netapp
+      Plugin to query performance values from a NetApp storage system using the
+      “Manage ONTAP” SDK provided by NetApp.
+

     - netlink
       Very detailed Linux network interface and routing statistics. You can get
       (detailed) information on interfaces, qdiscs, classes, and, if you can
     - netlink
       Very detailed Linux network interface and routing statistics. You can get
       (detailed) information on interfaces, qdiscs, classes, and, if you can


@@ -165,6 +180,10 @@ 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).
 

+    - olsrd
+      Queries routing information from the “Optimized Link State Routing”
+      daemon.
+

     - onewire (EXPERIMENTAL!)
       Read onewire sensors using the owcapu library of the owfs project.
       Please read in collectd.conf(5) why this plugin is experimental.
     - onewire (EXPERIMENTAL!)
       Read onewire sensors using the owcapu library of the owfs project.
       Please read in collectd.conf(5) why this plugin is experimental.


@@ -198,6 +217,15 @@ Features
     - protocols
       Counts various aspects of network protocols such as IP, TCP, UDP, etc.
 
     - protocols
       Counts various aspects of network protocols such as IP, TCP, UDP, etc.
 

+    - python
+      The python plugin implements a Python interpreter into collectd. This
+      makes it possible to write plugins in Python which are executed by
+      collectd without the need to start a heavy interpreter every interval.
+      See collectd-python(5) for details.
+
+    - routeros
+      Query interface and wireless registration statistics from RouterOS.
+

     - rrdcached
       RRDtool caching daemon (RRDcacheD) statistics.
 
     - rrdcached
       RRDtool caching daemon (RRDcacheD) statistics.
 


@@ -238,6 +266,10 @@ Features
     - thermal
       Linux ACPI thermal zone information.
 
     - thermal
       Linux ACPI thermal zone information.
 

+    - tokyotyrant
+      Reads the number of records and file size from a running Tokyo Tyrant
+      server.
+

     - uptime
       System uptime statistics.
 
     - uptime
       System uptime statistics.
 


@@ -258,7 +290,10 @@ Features
     - xmms
       Bitrate and frequency of music played with XMMS.
 
     - xmms
       Bitrate and frequency of music played with XMMS.
 

-  * Output can be written or send to various destinations by the following
+    - zfs_arc
+      Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
+
+  * Output can be written or sent to various destinations by the following

     plugins:
 
     - csv
     plugins:
 
     - csv


@@ -275,6 +310,10 @@ 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).
 

+    - python
+      It's possible to implement write plugins in Python using the python
+      plugin. See collectd-python(5) for details.
+

     - rrdcached
       Output to round-robin-database (RRD) files using the RRDtool caching
       daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
     - rrdcached
       Output to round-robin-database (RRD) files using the RRDtool caching
       daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general


@@ -292,6 +331,11 @@ Features
       needed. Please read collectd-unixsock(5) for a description on how that's
       done.
 
       needed. Please read collectd-unixsock(5) for a description on how that's
       done.
 

+    - write_http
+      Sends the values collected by collectd to a web-server using HTTP POST
+      requests. The transmitted data is either in a form understood by the
+      Exec plugin or formatted in JSON.
+

   * Logging is, as everything in collectd, provided by plugins. The following
     plugins keep up informed about what's going on:
 
   * Logging is, as everything in collectd, provided by plugins. The following
     plugins keep up informed about what's going on:
 


@@ -302,6 +346,10 @@ Features
       Log messages are propagated to plugins written in Perl as well.
       See collectd-perl(5).
 
       Log messages are propagated to plugins written in Perl as well.
       See collectd-perl(5).
 

+    - python
+      It's possible to implement log plugins in Python using the python plugin.
+      See collectd-python(5) for details.
+

     - syslog
       Logs to the standard UNIX logging mechanism, syslog.
 
     - syslog
       Logs to the standard UNIX logging mechanism, syslog.
 


@@ -331,9 +379,19 @@ 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).
 

+    - python
+      It's possible to implement notification plugins in Python using the
+      python plugin. See collectd-python(5) for details.
+

   * Value processing can be controlled using the "filter chain" infrastructure
     and "matches" and "targets". The following plugins are available:
 
   * Value processing can be controlled using the "filter chain" infrastructure
     and "matches" and "targets". The following plugins are available:
 

+    - match_empty_counter
+      Match counter values which are currently zero.
+
+    - match_hashed
+      Match values using a hash function of the hostname.
+

     - match_regex
       Match values by their identifier based on regular expressions.
 
     - match_regex
       Match values by their identifier based on regular expressions.
 


@@ -349,6 +407,9 @@ Features
     - target_replace
       Replace parts of an identifier using regular expressions.
 
     - target_replace
       Replace parts of an identifier using regular expressions.
 

+    - target_scale
+      Scale (multiply) values by an arbitrary value.
+

     - target_set
       Set (overwrite) entire parts of an identifier.
 
     - target_set
       Set (overwrite) entire parts of an identifier.
 


@@ -365,7 +426,7 @@ Features
     network plugins, makes sure your resources are used efficiently. Also,
     since collectd is programmed multithreaded it benefits from hyperthreading
     and multicore processors and makes sure that the daemon isn't idle if only
     network plugins, makes sure your resources are used efficiently. Also,
     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.
+    one plugin 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.


@@ -432,7 +493,8 @@ Prerequisites
     Used by the `oracle' plugin.
 
   * libcurl (optional)
     Used by the `oracle' plugin.
 
   * libcurl (optional)

-    If you want to use the `apache', `ascent', `curl' or `nginx' plugin.
+    If you want to use the `apache', `ascent', `curl', `nginx', or `write_http'
+    plugin.

     <http://curl.haxx.se/>
 
   * libdbi (optional)
     <http://curl.haxx.se/>
 
   * libdbi (optional)


@@ -445,31 +507,44 @@ Prerequisites
 
   * libganglia (optional)
     Used by the `gmond' plugin to process data received from Ganglia.
 
   * libganglia (optional)
     Used by the `gmond' plugin to process data received from Ganglia.

+    <http://ganglia.info/>

 
   * libgcrypt (optional)
     Used by the `network' plugin for encryption and authentication.
 
   * libgcrypt (optional)
     Used by the `network' plugin for encryption and authentication.

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

 
   * libhal (optional)
     If present, the uuid plugin will check for UUID from HAL.
     <http://hal.freedesktop.org/>
 
 
   * libhal (optional)
     If present, the uuid plugin will check for UUID from HAL.
     <http://hal.freedesktop.org/>
 

-  * libiptc (optional, if not found a version shipped with this distribution
-    can be used if the Linux kernel headers are available)
+  * libiptc (optional)

     For querying iptables counters.
     <http://netfilter.org/>
 
     For querying iptables counters.
     <http://netfilter.org/>
 

+    If not found on the system, a version shipped with this distribution can
+    be used. It requires some Linux headers in /usr/include/linux. You can
+    force the build system to use the shipped version by specifying
+      --with-libiptc=shipped
+    when running the configure script.
+

   * libjvm (optional)
     Library that encapsulates the `Java Virtual Machine' (JVM). This library is
     used by the Java plugin to execute Java bytecode. See “Configuring with
     libjvm” below.
   * libjvm (optional)
     Library that encapsulates the `Java Virtual Machine' (JVM). This library is
     used by the Java plugin to execute Java bytecode. See “Configuring with
     libjvm” below.

+    <http://openjdk.java.net/> (and others)

 
   * libmemcached (optional)
     Used by the `memcachec' plugin to connect to a memcache daemon.
 
   * libmemcached (optional)
     Used by the `memcachec' plugin to connect to a memcache daemon.

+    <http://tangent.org/552/libmemcached.html>

 
   * libmysqlclient (optional)
     Unsurprisingly used by the `mysql' plugin.
     <http://dev.mysql.com/>
 
 
   * libmysqlclient (optional)
     Unsurprisingly used by the `mysql' plugin.
     <http://dev.mysql.com/>
 

+  * libnetapp (optional)
+    Required for the “netapp” plugin.
+    This library is part of the “Manage ONTAP SDK” published by NetApp.
+

   * libnetlink (optional)
     Used, obviously, for the `netlink' plugin.
     <http://www.linuxfoundation.org/en/Net:Iproute2>
   * libnetlink (optional)
     Used, obviously, for the `netlink' plugin.
     <http://www.linuxfoundation.org/en/Net:Iproute2>


@@ -482,8 +557,7 @@ Prerequisites
     For the `notify_desktop' plugin.
     <http://www.galago-project.org/>
 
     For the `notify_desktop' plugin.
     <http://www.galago-project.org/>
 

-  * liboping (optional, if not found a version shipped with this distribution
-    can be used)
+  * liboping (optional)

     Used by the `ping' plugin to send and receive ICMP packets.
     <http://verplant.org/liboping/>
 
     Used by the `ping' plugin to send and receive ICMP packets.
     <http://verplant.org/liboping/>
 


@@ -496,6 +570,9 @@ Prerequisites
     Used to capture packets by the `dns' plugin.
     <http://www.tcpdump.org/>
 
     Used to capture packets by the `dns' plugin.
     <http://www.tcpdump.org/>
 

+  * libperfstat (optional)
+    Used by various plugins to gather statistics under AIX.
+

   * 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).


@@ -505,6 +582,14 @@ Prerequisites
     The PostgreSQL C client library used by the `postgresql' plugin.
     <http://www.postgresql.org/>
 
     The PostgreSQL C client library used by the `postgresql' plugin.
     <http://www.postgresql.org/>
 

+  * libpython (optional)
+    Used by the `python' plugin. Currently, only 2.3 ≦ Python < 3 is supported.
+    <http://www.python.org/>
+
+  * librouteros (optional)
+    Used by the `routeros' plugin to connect to a device running `RouterOS'.
+    <http://verplant.org/librouteros/>
+

   * 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,
   * 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,


@@ -524,6 +609,10 @@ Prerequisites
     and/or Solaris.
     <http://www.i-scream.org/libstatgrab/>
 
     and/or Solaris.
     <http://www.i-scream.org/libstatgrab/>
 

+  * libtokyotyrant (optional)
+    Used by the tokyotyrant plugin.
+    <http://1978th.net/tokyotyrant/>
+

   * libupsclient/nut (optional)
     For the `nut' plugin which queries nut's `upsd'.
     <http://networkupstools.org/>
   * libupsclient/nut (optional)
     For the `nut' plugin which queries nut's `upsd'.
     <http://networkupstools.org/>


@@ -539,6 +628,9 @@ Prerequisites
   * libxmms (optional)
     <http://www.xmms.org/>
 
   * libxmms (optional)
     <http://www.xmms.org/>
 

+  * libyajl (optional)
+    Parse JSON data. This is needed for the `curl_json' plugin.
+    <http://github.com/lloyd/yajl>

 
 Configuring / Compiling / Installing
 ------------------------------------
 
 Configuring / Compiling / Installing
 ------------------------------------