Merge remote-tracking branch 'origin/pr/603'

[collectd.git] / README

diff --git a/README b/README
index 3f65963..60de1ed 100644 (file)
--- a/README
+++ b/README
@@ -26,9 +26,17 @@ Features
       Sensors in Macs running Mac OS X / Darwin: Temperature, fanspeed and
       voltage sensors.
 
       Sensors in Macs running Mac OS X / Darwin: Temperature, fanspeed and
       voltage sensors.
 

+    - aquaero
+      Various sensors in the Aquaero 5 watercooling board made by Aquacomputer.
+

     - ascent
       Statistics about Ascent, a free server for the game `World of Warcraft'.
 
     - ascent
       Statistics about Ascent, a free server for the game `World of Warcraft'.
 

+    - barometer
+      Using digital barometer sensor MPL115A2 or MPL3115 from Freescale
+      provides absolute barometric pressure, air pressure reduced to sea level
+      and temperature.
+

     - battery
       Batterycharge, -current and voltage of ACPI and PMU based laptop
       batteries.
     - battery
       Batterycharge, -current and voltage of ACPI and PMU based laptop
       batteries.


@@ -79,6 +87,9 @@ Features
       DNS traffic: Query types, response codes, opcodes and traffic/octets
       transfered.
 
       DNS traffic: Query types, response codes, opcodes and traffic/octets
       transfered.
 

+    - drbd
+      Collect individual drbd resource statistics.
+

     - email
       Email statistics: Count, traffic, spam scores and checks.
       See collectd-email(5).
     - email
       Email statistics: Count, traffic, spam scores and checks.
       See collectd-email(5).


@@ -280,11 +291,20 @@ Features
     - serial
       RX and TX of serial interfaces. Linux only; needs root privileges.
 
     - serial
       RX and TX of serial interfaces. Linux only; needs root privileges.
 

+    - sigrok
+      Uses libsigrok as a backend, allowing any sigrok-supported device
+      to have its measurements fed to collectd. This includes multimeters,
+      sound level meters, thermometers, and much more.
+

     - snmp
       Read values from SNMP (Simple Network Management Protocol) enabled
       network devices such as switches, routers, thermometers, rack monitoring
       servers, etc. See collectd-snmp(5).
 
     - snmp
       Read values from SNMP (Simple Network Management Protocol) enabled
       network devices such as switches, routers, thermometers, rack monitoring
       servers, etc. See collectd-snmp(5).
 

+    - statsd
+      Acts as a StatsD server, reading values sent over the network from StatsD
+      clients and calculating rates and other aggregates out of these values.
+

     - swap
       Pages swapped out onto harddisk or whatever is called `swap' by the OS..
 
     - swap
       Pages swapped out onto harddisk or whatever is called `swap' by the OS..
 


@@ -396,6 +416,9 @@ Features
       requests. The transmitted data is either in a form understood by the
       Exec plugin or formatted in JSON.
 
       requests. The transmitted data is either in a form understood by the
       Exec plugin or formatted in JSON.
 

+    - write_kafka
+      Sends data to Apache Kafka, a distributed queue.
+

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


@@ -409,7 +432,7 @@ Features
     plugins keep up informed about what's going on:
 
     - logfile
     plugins keep up informed about what's going on:
 
     - logfile

-      Writes logmessages to a file or STDOUT/STDERR.
+      Writes log messages to a file or STDOUT/STDERR.

 
     - perl
       Log messages are propagated to plugins written in Perl as well.
 
     - perl
       Log messages are propagated to plugins written in Perl as well.


@@ -422,6 +445,9 @@ Features
     - syslog
       Logs to the standard UNIX logging mechanism, syslog.
 
     - syslog
       Logs to the standard UNIX logging mechanism, syslog.
 

+    - log_logstash
+      Writes log messages formatted as logstash JSON events.
+

   * Notifications can be handled by the following plugins:
 
     - notify_desktop
   * Notifications can be handled by the following plugins:
 
     - notify_desktop


@@ -557,10 +583,18 @@ Prerequisites
 
   * A POSIX-threads (pthread) implementation.
     Since gathering some statistics is slow (network connections, slow devices,
 
   * A POSIX-threads (pthread) implementation.
     Since gathering some statistics is slow (network connections, slow devices,

-    etc) the collectd is parallelized. The POSIX threads interface is being
+    etc) collectd is parallelized. The POSIX threads interface is being

     used and should be found in various implementations for hopefully all
     platforms.
 
     used and should be found in various implementations for hopefully all
     platforms.
 

+  * aerotools-ng (optional)
+    Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
+    is used by the `aerotools-ng' toolkit, is not compiled as a shared object
+    nor does it feature an installation routine. Therefore, you need to point
+    collectd's configure script at the source directory of the `aerotools-ng'
+    project.
+    <https://github.com/lynix/aerotools-ng>
+

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


@@ -570,12 +604,12 @@ Prerequisites
     Used by the `oracle' plugin.
 
   * libcredis (optional)
     Used by the `oracle' plugin.
 
   * libcredis (optional)

-    Used by the redis plugin. Please note that you require a 0.2.2 version
+    Used by the `redis' plugin. Please note that you require a 0.2.2 version

     or higher. <http://code.google.com/p/credis/>
 
   * libcurl (optional)
     or higher. <http://code.google.com/p/credis/>
 
   * libcurl (optional)

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

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


@@ -595,32 +629,38 @@ Prerequisites
     <http://www.gnupg.org/>
 
   * libhal (optional)
     <http://www.gnupg.org/>
 
   * libhal (optional)

-    If present, the uuid plugin will check for UUID from HAL.
+    If present, the `uuid' plugin will check for UUID from HAL.

     <http://hal.freedesktop.org/>
 
     <http://hal.freedesktop.org/>
 

+  * libi2c-dev (optional)
+    Used for the plugin `barometer', provides just the i2c-dev.h header file
+    for user space i2c development.
+

   * libiptc (optional)
     For querying iptables counters.
     <http://netfilter.org/>
 
   * libiptc (optional)
     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
   * 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
+    used by the `java' plugin to execute Java bytecode. See “Configuring with

     libjvm” below.
     <http://openjdk.java.net/> (and others)
 
     libjvm” below.
     <http://openjdk.java.net/> (and others)
 

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

   * libmemcached (optional)
     Used by the `memcachec' plugin to connect to a memcache daemon.
     <http://tangent.org/552/libmemcached.html>
 
   * libmemcached (optional)
     Used by the `memcachec' plugin to connect to a memcache daemon.
     <http://tangent.org/552/libmemcached.html>
 

+  * libmnl (optional)
+    Used by the `netlink' plugin.
+    <http://www.netfilter.org/projects/libmnl/>
+

   * libmodbus (optional)
   * libmodbus (optional)

-    Used by the “modbus” plugin to communicate with Modbus/TCP devices. The
-    “modbus” plugin works with version 2.0.3 of the library – due to frequent
+    Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
+    `modbus' plugin works with version 2.0.3 of the library – due to frequent

     API changes other versions may or may not compile cleanly.
     <http://www.libmodbus.org/>
 
     API changes other versions may or may not compile cleanly.
     <http://www.libmodbus.org/>
 


@@ -629,13 +669,9 @@ Prerequisites
     <http://dev.mysql.com/>
 
   * libnetapp (optional)
     <http://dev.mysql.com/>
 
   * libnetapp (optional)

-    Required for the “netapp” plugin.
+    Required for the `netapp' plugin.

     This library is part of the “Manage ONTAP SDK” published by NetApp.
 
     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>
-

   * libnetsnmp (optional)
     For the `snmp' plugin.
     <http://www.net-snmp.org/>
   * libnetsnmp (optional)
     For the `snmp' plugin.
     <http://www.net-snmp.org/>


@@ -644,9 +680,13 @@ Prerequisites
     For the `notify_desktop' plugin.
     <http://www.galago-project.org/>
 
     For the `notify_desktop' plugin.
     <http://www.galago-project.org/>
 

+  * libopenipmi (optional)
+    Used by the `ipmi' plugin to prove IPMI devices.
+    <http://openipmi.sourceforge.net/>
+

   * liboping (optional)
     Used by the `ping' plugin to send and receive ICMP packets.
   * liboping (optional)
     Used by the `ping' plugin to send and receive ICMP packets.

-    <http://verplant.org/liboping/>
+    <http://octo.it/liboping/>

 
   * libowcapi (optional)
     Used by the `onewire' plugin to read values from onewire sensors (or the
 
   * libowcapi (optional)
     Used by the `onewire' plugin to read values from onewire sensors (or the


@@ -671,7 +711,8 @@ Prerequisites
 
   * libprotobuf-c, protoc-c (optional)
     Used by the `pinba' plugin to generate a parser for the network packets
 
   * libprotobuf-c, protoc-c (optional)
     Used by the `pinba' plugin to generate a parser for the network packets

-    sent by the Pinba PHP extension.
+    sent by the Pinba PHP extension, and by the `write_riemann' plugin to
+    generate events to be sent to a Riemann server.

     <http://code.google.com/p/protobuf-c/>
 
   * libpython (optional)
     <http://code.google.com/p/protobuf-c/>
 
   * libpython (optional)


@@ -680,12 +721,17 @@ Prerequisites
     <http://www.python.org/>
 
   * librabbitmq (optional; also called “rabbitmq-c”)
     <http://www.python.org/>
 
   * librabbitmq (optional; also called “rabbitmq-c”)

-    Used by the AMQP plugin for AMQP connections, for example to RabbitMQ.
+    Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.

     <http://hg.rabbitmq.com/rabbitmq-c/>
 
     <http://hg.rabbitmq.com/rabbitmq-c/>
 

+  * librdkafka (optional; also called “rdkafka”)
+    Used by the `write_kafka' plugin for producing messages and sending them
+    to a Kafka broker.
+    <https://github.com/edenhill/librdkafka>
+

   * librouteros (optional)
     Used by the `routeros' plugin to connect to a device running `RouterOS'.
   * librouteros (optional)
     Used by the `routeros' plugin to connect to a device running `RouterOS'.

-    <http://verplant.org/librouteros/>
+    <http://octo.it/librouteros/>

 
   * librrd (optional)
     Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
 
   * librrd (optional)
     Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool


@@ -701,13 +747,18 @@ Prerequisites
     To read from `lm_sensors', see the `sensors' plugin.
     <http://www.lm-sensors.org/>
 
     To read from `lm_sensors', see the `sensors' plugin.
     <http://www.lm-sensors.org/>
 

+  * libsigrok (optional)
+    Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
+    libzip, and optionally (depending on which drivers are enabled) on
+    libusb, libftdi and libudev.
+

   * libstatgrab (optional)
     Used by various plugins to collect statistics on systems other than Linux
     and/or Solaris.
     <http://www.i-scream.org/libstatgrab/>
 
   * libtokyotyrant (optional)
   * libstatgrab (optional)
     Used by various plugins to collect statistics on systems other than Linux
     and/or Solaris.
     <http://www.i-scream.org/libstatgrab/>
 
   * libtokyotyrant (optional)

-    Used by the tokyotyrant plugin.
+    Used by the `tokyotyrant' plugin.

     <http://1978th.net/tokyotyrant/>
 
   * libupsclient/nut (optional)
     <http://1978th.net/tokyotyrant/>
 
   * libupsclient/nut (optional)


@@ -719,18 +770,21 @@ Prerequisites
     <http://libvirt.org/>
 
   * libxml2 (optional)
     <http://libvirt.org/>
 
   * libxml2 (optional)

-    Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
+    Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
+    `libvirt' plugins.

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

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

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

-     Fetches statistics from a Varnish instance. This is needed for the Varnish plugin
+     Fetches statistics from a Varnish instance. This is needed for the
+     `varnish' plugin.

      <http://varnish-cache.org>
 
 Configuring / Compiling / Installing
      <http://varnish-cache.org>
 
 Configuring / Compiling / Installing


@@ -836,7 +890,7 @@ Contact
 
   For questions, bug reports, development information and basically all other
   concerns please send an email to collectd's mailing list 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>.
+  <list at collectd.org>.

 
   For live discussion and more personal contact visit us in IRC, we're in
   channel #collectd on freenode.
 
   For live discussion and more personal contact visit us in IRC, we're in
   channel #collectd on freenode.


@@ -845,7 +899,7 @@ Contact
 Author
 ------
 
 Author
 ------
 

-  Florian octo Forster <octo at verplant.org>,
+  Florian octo Forster <octo at collectd.org>,

   Sebastian tokkee Harl <sh at tokkee.org>,
   and many contributors (see `AUTHORS').
 
   Sebastian tokkee Harl <sh at tokkee.org>,
   and many contributors (see `AUTHORS').