{GPL, other}: Relicense to MIT license.

[collectd.git] / README

diff --git a/README b/README
index 45dcadb..bcedb62 100644 (file)
--- a/README
+++ b/README
@@ -26,6 +26,9 @@ 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'.
 


@@ -37,6 +40,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.
 

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

     - conntrack
       Number of nf_conntrack entries.
 
     - conntrack
       Number of nf_conntrack entries.
 


@@ -133,7 +139,11 @@ Features
       technique built into IBM's POWER processors.
 
     - libvirt
       technique built into IBM's POWER processors.
 
     - libvirt

-      CPU, disk and network I/O statistics from virtual machines.
+      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).

 
     - madwifi
       Queries very detailed usage statistics from wireless LAN adapters and
 
     - madwifi
       Queries very detailed usage statistics from wireless LAN adapters and


@@ -158,6 +168,10 @@ Features
       Memory utilization: Memory occupied by running processes, page cache,
       buffer cache and free.
 
       Memory utilization: Memory occupied by running processes, page cache,
       buffer cache and free.
 

+    - mic
+      Collects CPU usage, memory usage, temperatures and power consumption from
+      Intel Many Integrated Core (MIC) CPUs.
+

     - modbus
       Reads values from Modbus/TCP enabled devices. Supports reading values
       from multiple "slaves" so gateway devices can be used.
     - modbus
       Reads values from Modbus/TCP enabled devices. Supports reading values
       from multiple "slaves" so gateway devices can be used.


@@ -269,6 +283,11 @@ 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
     - snmp
       Read values from SNMP (Simple Network Management Protocol) enabled
       network devices such as switches, routers, thermometers, rack monitoring


@@ -284,6 +303,10 @@ Features
       Follows (tails) logfiles, parses them by lines and submits matched
       values.
 
       Follows (tails) logfiles, parses them by lines and submits matched
       values.
 

+    - tail_csv
+      Follows (tails) files in CSV format, parses each line and submits
+      extracted values.
+

     - tape
       Bytes and operations read and written on tape devices. Solaris only.
 
     - tape
       Bytes and operations read and written on tape devices. Solaris only.
 


@@ -372,16 +395,27 @@ Features
       done.
 
     - write_graphite
       done.
 
     - write_graphite

-      Sends data to Carbon, the storage layer of Graphite.
+      Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
+      can be configured to avoid logging send errors (especially useful when
+      using UDP).

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

+    - write_kafka
+      Sends data to Apache Kafka, a distributed queue.
+
+    - write_mongodb
+      Sends data to MongoDB, a NoSQL database.
+

     - write_redis
       Sends the values to a Redis key-value database server.
 
     - write_redis
       Sends the values to a Redis key-value database server.
 

+    - write_riemann
+      Sends data to Riemann, a stream processing and monitoring system.
+

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


@@ -534,10 +568,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.


@@ -595,6 +637,10 @@ Prerequisites
     Used by the `memcachec' plugin to connect to a memcache daemon.
     <http://tangent.org/552/libmemcached.html>
 
     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)
     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
   * 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


@@ -609,10 +655,6 @@ Prerequisites
     Required for the “netapp” plugin.
     This library is part of the “Manage ONTAP SDK” published by NetApp.
 
     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>
-

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


@@ -623,7 +665,7 @@ Prerequisites
 
   * 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


@@ -660,9 +702,13 @@ Prerequisites
     Used by the AMQP plugin for AMQP connections, for example to RabbitMQ.
     <http://hg.rabbitmq.com/rabbitmq-c/>
 
     Used by the AMQP plugin for AMQP connections, for example to RabbitMQ.
     <http://hg.rabbitmq.com/rabbitmq-c/>
 

+  * librdkafka (optional; also called “rdkafka”)
+    Used by the Kafka plugin for producing.
+    <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


@@ -678,6 +724,11 @@ 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.
   * libstatgrab (optional)
     Used by various plugins to collect statistics on systems other than Linux
     and/or Solaris.


@@ -813,7 +864,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.


@@ -822,7 +873,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').