Merge remote-tracking branch 'origin/pr/752' into wh_low_speed_limit

[collectd.git] / README

diff --git a/README b/README
index 7aa83b0..9fb9004 100644 (file)
--- a/README
+++ b/README
@@ -45,6 +45,9 @@ Features
       Name server and resolver statistics from the `statistics-channel'
       interface of BIND 9.5, 9,6 and later.
 
       Name server and resolver statistics from the `statistics-channel'
       interface of BIND 9.5, 9,6 and later.
 

+    - ceph
+      Statistics from the Ceph distributed storage system.
+

     - cgroups
       CPU accounting information for process groups under Linux.
 
     - cgroups
       CPU accounting information for process groups under Linux.
 


@@ -229,6 +232,9 @@ Features
       Read onewire sensors using the owcapu library of the owfs project.
       Please read in collectd.conf(5) why this plugin is experimental.
 
       Read onewire sensors using the owcapu library of the owfs project.
       Please read in collectd.conf(5) why this plugin is experimental.
 

+    - openldap
+      Read monitoring information from OpenLDAP's cn=Monitor subtree.
+

     - openvpn
       RX and TX of each client in openvpn-status.log (status-version 2).
       <http://openvpn.net/index.php/documentation/howto.html>
     - openvpn
       RX and TX of each client in openvpn-status.log (status-version 2).
       <http://openvpn.net/index.php/documentation/howto.html>


@@ -368,6 +374,9 @@ Features
     - zfs_arc
       Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
 
     - zfs_arc
       Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
 

+    - zookeeper
+      Read data from Zookeeper's MNTR command.
+

   * Output can be written or sent to various destinations by the following
     plugins:
 
   * Output can be written or sent to various destinations by the following
     plugins:
 


@@ -427,6 +436,9 @@ Features
     - write_kafka
       Sends data to Apache Kafka, a distributed queue.
 
     - write_kafka
       Sends data to Apache Kafka, a distributed queue.
 

+    - write_log
+      Writes data to the log
+

     - write_mongodb
       Sends data to MongoDB, a NoSQL database.
 
     - write_mongodb
       Sends data to MongoDB, a NoSQL database.
 


@@ -608,12 +620,16 @@ Prerequisites
     particular.
     <http://developer.apple.com/corefoundation/>
 
     particular.
     <http://developer.apple.com/corefoundation/>
 

+  * libatasmart (optional)
+    Used by the `smart' plugin.
+    <http://git.0pointer.de/?p=libatasmart.git>
+

   * libclntsh (optional)
     Used by the `oracle' plugin.
 
   * libclntsh (optional)
     Used by the `oracle' plugin.
 

-  * libcredis (optional)
-    Used by the `redis' plugin. Please note that you require a 0.2.2 version
-    or higher. <http://code.google.com/p/credis/>
+  * libhiredis (optional)
+    Used by the redis plugin. Please note that you require a 0.10.0 version
+    or higher. <https://github.com/redis/hiredis>

 
   * libcurl (optional)
     If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
 
   * libcurl (optional)
     If you want to use the `apache', `ascent', `bind', `curl', `curl_json',


@@ -654,6 +670,10 @@ Prerequisites
     libjvm” below.
     <http://openjdk.java.net/> (and others)
 
     libjvm” below.
     <http://openjdk.java.net/> (and others)
 

+  * libldap (optional)
+    Used by the `openldap' plugin.
+    <http://www.openldap.org/>
+

   * liblvm2 (optional)
     Used by the `lvm' plugin.
     <ftp://sources.redhat.com/pub/lvm2/>
   * liblvm2 (optional)
     Used by the `lvm' plugin.
     <ftp://sources.redhat.com/pub/lvm2/>


@@ -786,8 +806,8 @@ Prerequisites
     <http://www.xmms.org/>
 
   * libyajl (optional)
     <http://www.xmms.org/>
 
   * libyajl (optional)

-    Parse JSON data. This is needed for the `curl_json' and `log_logstash'
-    plugins.
+    Parse JSON data. This is needed for the `ceph', `curl_json' and
+    `log_logstash' plugins.

     <http://github.com/lloyd/yajl>
 
   * libvarnish (optional)
     <http://github.com/lloyd/yajl>
 
   * libvarnish (optional)


@@ -862,6 +882,23 @@ Configuring with libjvm
   Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to
   do that.
 
   Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to
   do that.
 

+Generating the configure script
+-------------------------------
+
+Collectd ships with a `build.sh' script to generate the `configure'
+script shipped with releases.
+
+To generate the `configure` script, you'll need the following dependencies:
+
+- autoconf
+- automake
+- flex
+- bison
+- libtool
+- libtool-ltdl
+
+The `build.sh' script takes no arguments.
+

 Crosscompiling
 --------------
 
 Crosscompiling
 --------------