Turbostat: whitespace cleanup

[collectd.git] / README

diff --git a/README b/README
index 1956609..133c034 100644 (file)
--- a/README
+++ b/README
@@ -146,9 +146,6 @@ Features
       Detailed CPU statistics of the “Logical Partitions” virtualization
       technique built into IBM's POWER processors.
 
       Detailed CPU statistics of the “Logical Partitions” virtualization
       technique built into IBM's POWER processors.
 

-    - libvirt
-      CPU, memory, disk and network I/O statistics from virtual machines.
-

     - lvm
       Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
       “Logical Volume Manager” (LVM).
     - lvm
       Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
       “Logical Volume Manager” (LVM).


@@ -232,6 +229,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>


@@ -296,6 +296,10 @@ Features
       to have its measurements fed to collectd. This includes multimeters,
       sound level meters, thermometers, and much more.
 
       to have its measurements fed to collectd. This includes multimeters,
       sound level meters, thermometers, and much more.
 

+    - smart
+      Collect SMART statistics, notably load cycle count, temperature
+      and bad sectors.
+

     - snmp
       Read values from SNMP (Simple Network Management Protocol) enabled
       network devices such as switches, routers, thermometers, rack monitoring
     - snmp
       Read values from SNMP (Simple Network Management Protocol) enabled
       network devices such as switches, routers, thermometers, rack monitoring


@@ -338,6 +342,10 @@ Features
       Reads the number of records and file size from a running Tokyo Tyrant
       server.
 
       Reads the number of records and file size from a running Tokyo Tyrant
       server.
 

+    - turbostat
+      Reads CPU frequency and C-state residency on modern Intel
+      turbo-capable processors.
+

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


@@ -347,6 +355,9 @@ Features
     - varnish
       Various statistics from Varnish, an HTTP accelerator.
 
     - varnish
       Various statistics from Varnish, an HTTP accelerator.
 

+    - virt
+      CPU, memory, disk and network I/O statistics from virtual machines.
+

     - vmem
       Virtual memory statistics, e. g. the number of page-ins/-outs or the
       number of pagefaults.
     - vmem
       Virtual memory statistics, e. g. the number of page-ins/-outs or the
       number of pagefaults.


@@ -364,6 +375,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:
 


@@ -423,6 +437,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.
 


@@ -604,12 +621,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',


@@ -650,6 +671,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/>


@@ -775,7 +800,7 @@ Prerequisites
 
   * libxml2 (optional)
     Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
 
   * libxml2 (optional)
     Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and

-    `libvirt' plugins.
+    `virt' plugins.

     <http://xmlsoft.org/>
 
   * libxmms (optional)
     <http://xmlsoft.org/>
 
   * libxmms (optional)


@@ -858,6 +883,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
 --------------