utils_subst.c: add header for prototypes

[collectd.git] / README

diff --git a/README b/README
index 17b62d8..430f52c 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.
 


@@ -83,6 +89,9 @@ Features
     - entropy
       Amount of entropy available to the system.
 
     - entropy
       Amount of entropy available to the system.
 

+    - ethstat
+      Network interface card statistics.
+

     - exec
       Values gathered by a custom program or script.
       See collectd-exec(5).
     - exec
       Values gathered by a custom program or script.
       See collectd-exec(5).


@@ -125,8 +134,16 @@ Features
     - load
       System load average over the last 1, 5 and 15 minutes.
 
     - load
       System load average over the last 1, 5 and 15 minutes.
 

+    - lpar
+      Detailed CPU statistics of the “Logical Partitions” virtualization
+      technique built into IBM's POWER processors.
+

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


@@ -136,6 +153,10 @@ Features
       Motherboard sensors: temperature, fanspeed and voltage information,
       using mbmon(1).
 
       Motherboard sensors: temperature, fanspeed and voltage information,
       using mbmon(1).
 

+    - md
+      Linux software-RAID device information (number of active, failed, spare
+      and missing disks).
+

     - memcachec
       Query and parse data from a memcache daemon (memcached).
 
     - memcachec
       Query and parse data from a memcache daemon (memcached).
 


@@ -147,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.


@@ -188,6 +213,9 @@ 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).
 

+    - numa
+      Information about Non-Uniform Memory Access (NUMA).
+

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


@@ -208,6 +236,9 @@ Features
       write your own plugins in Perl and return arbitrary values using this
       API. See collectd-perl(5).
 
       write your own plugins in Perl and return arbitrary values using this
       API. See collectd-perl(5).
 

+    - pf
+      Query statistics from BSD's packet filter "pf".
+

     - pinba
       Receive and dispatch timing values from Pinba, a profiling extension for
       PHP.
     - pinba
       Receive and dispatch timing values from Pinba, a profiling extension for
       PHP.


@@ -235,6 +266,10 @@ Features
       collectd without the need to start a heavy interpreter every interval.
       See collectd-python(5) for details.
 
       collectd without the need to start a heavy interpreter every interval.
       See collectd-python(5) for details.
 

+    - redis
+      The redis plugin gathers information from a redis server, including:
+      uptime, used memory, total connections etc.
+

     - routeros
       Query interface and wireless registration statistics from RouterOS.
 
     - routeros
       Query interface and wireless registration statistics from RouterOS.
 


@@ -248,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


@@ -263,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.
 


@@ -288,6 +332,9 @@ Features
     - users
       Users currently logged in.
 
     - users
       Users currently logged in.
 

+    - varnish
+      Various statistics from Varnish, an HTTP accelerator.
+

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


@@ -308,6 +355,10 @@ Features
   * 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:
 

+    - amqp
+      Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
+      server, such as RabbitMQ.
+

     - csv
       Write to comma separated values (CSV) files. This needs lots of
       diskspace but is extremely portable and can be analysed with almost
     - csv
       Write to comma separated values (CSV) files. This needs lots of
       diskspace but is extremely portable and can be analysed with almost


@@ -343,13 +394,27 @@ 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_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_mongodb
+      Sends data to MongoDB, a NoSQL database.
+
+    - 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
   * Logging is, as everything in collectd, provided by plugins. The following

-    plugins keep up informed about what's going on:
+    plugins keep us informed about what's going on:

 
     - logfile
       Writes logmessages to a file or STDOUT/STDERR.
 
     - logfile
       Writes logmessages to a file or STDOUT/STDERR.


@@ -427,6 +492,14 @@ Features
 
   * Miscellaneous plugins:
 
 
   * Miscellaneous plugins:
 

+    - aggregation
+      Selects multiple value lists based on patterns or regular expressions
+      and creates new aggregated values lists from those.
+
+    - threshold
+      Checks values against configured thresholds and creates notifications if
+      values are out of bounds. See collectd-threshold(5) for details.
+

     - uuid
       Sets the hostname to an unique identifier. This is meant for setups
       where each client may migrate to another physical host, possibly going
     - uuid
       Sets the hostname to an unique identifier. This is meant for setups
       where each client may migrate to another physical host, possibly going


@@ -496,6 +569,14 @@ Prerequisites
     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.


@@ -504,6 +585,10 @@ Prerequisites
   * 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/>
+

   * libcurl (optional)
     If you want to use the `apache', `ascent', `curl', `nginx', or `write_http'
     plugin.
   * libcurl (optional)
     If you want to use the `apache', `ascent', `curl', `nginx', or `write_http'
     plugin.


@@ -549,9 +634,15 @@ 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)
   * libmodbus (optional)

-    Used by the `modbus' plugin to communicate with Modbus/TCP devices.
-    <https://launchpad.net/libmodbus>
+    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/>

 
   * libmysqlclient (optional)
     Unsurprisingly used by the `mysql' plugin.
 
   * libmysqlclient (optional)
     Unsurprisingly used by the `mysql' plugin.


@@ -561,10 +652,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/>


@@ -586,6 +673,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).


@@ -601,9 +691,14 @@ Prerequisites
     <http://code.google.com/p/protobuf-c/>
 
   * libpython (optional)
     <http://code.google.com/p/protobuf-c/>
 
   * libpython (optional)

-    Used by the `python' plugin. Currently, only 2.3 ≦ Python < 3 is supported.
+    Used by the `python' plugin. Currently, Python 2.3 and later and Python 3
+    are supported.

     <http://www.python.org/>
 
     <http://www.python.org/>
 

+  * librabbitmq (optional; also called “rabbitmq-c”)
+    Used by the AMQP plugin for AMQP connections, for example to RabbitMQ.
+    <http://hg.rabbitmq.com/rabbitmq-c/>
+

   * librouteros (optional)
     Used by the `routeros' plugin to connect to a device running `RouterOS'.
     <http://verplant.org/librouteros/>
   * librouteros (optional)
     Used by the `routeros' plugin to connect to a device running `RouterOS'.
     <http://verplant.org/librouteros/>


@@ -622,6 +717,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.