java bindings: DataSource: Add `DERIVE' and `ABSOLUTE'.

[collectd.git] / README

diff --git a/README b/README
index 5c9eed0..1cfa643 100644 (file)
--- a/README
+++ b/README
@@ -33,6 +33,19 @@ Features
       Batterycharge, -current and voltage of ACPI and PMU based laptop
       batteries.
 
       Batterycharge, -current and voltage of ACPI and PMU based laptop
       batteries.
 

+    - curl
+      Parse statistics from websites using regular expressions.
+
+    - bind
+      Name server and resolver statistics from the `statistics-channel'
+      interface of BIND 9.5, 9,6 and later.
+
+    - conntrack
+      Number of nf_conntrack entries.
+
+    - couchdb
+      Parse statistics from CouchDB JSON documents.
+

     - cpu
       CPU utilization: Time spent in the system, user, nice, idle, and related
       states.
     - cpu
       CPU utilization: Time spent in the system, user, nice, idle, and related
       states.


@@ -69,6 +82,12 @@ Features
     - filecount
       Count the number of files in directories.
 
     - filecount
       Count the number of files in directories.
 

+    - fscache
+      Linux file-system based caching framework statistics.
+
+    - gmond
+      Receive multicast traffic from Ganglia instances.
+

     - hddtemp
       Harddisk temperatures using hddtempd.
 
     - hddtemp
       Harddisk temperatures using hddtempd.
 


@@ -91,6 +110,10 @@ Features
     - irq
       IRQ counters: Frequency in which certain interrupts occur.
 
     - irq
       IRQ counters: Frequency in which certain interrupts occur.
 

+    - java
+      Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
+      bytecode. See “Configuring with libjvm” below.
+

     - load
       System load average over the last 1, 5 and 15 minutes.
 
     - load
       System load average over the last 1, 5 and 15 minutes.
 


@@ -101,6 +124,9 @@ Features
       Motherboard sensors: temperature, fanspeed and voltage information,
       using mbmon(1).
 
       Motherboard sensors: temperature, fanspeed and voltage information,
       using mbmon(1).
 

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

     - memcached
       Statistics of the memcached distributed caching system.
       <http://www.danga.com/memcached/>
     - memcached
       Statistics of the memcached distributed caching system.
       <http://www.danga.com/memcached/>


@@ -146,6 +172,13 @@ 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.
 

+    - openvpn
+      RX and TX of each client in openvpn-status.log (status-version 2).
+      <http://openvpn.net/index.php/documentation/howto.html>
+
+    - oracle
+      Query data from an Oracle database.
+

     - perl
       The perl plugin implements a Perl-interpreter into collectd. You can
       write your own plugins in Perl and return arbitrary values using this
     - perl
       The perl plugin implements a Perl-interpreter into collectd. You can
       write your own plugins in Perl and return arbitrary values using this


@@ -165,6 +198,9 @@ Features
     - processes
       Process counts: Number of running, sleeping, zombie, ... processes.
 
     - processes
       Process counts: Number of running, sleeping, zombie, ... processes.
 

+    - protocols
+      Counts various aspects of network protocols such as IP, TCP, UDP, etc.
+

     - rrdcached
       RRDtool caching daemon (RRDcacheD) statistics.
 
     - rrdcached
       RRDtool caching daemon (RRDcacheD) statistics.
 


@@ -183,6 +219,9 @@ Features
     - 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..
 

+    - table
+      Parse table-like structured files.
+

     - tail
       Follows (tails) logfiles, parses them by lines and submits matched
       values.
     - tail
       Follows (tails) logfiles, parses them by lines and submits matched
       values.


@@ -196,9 +235,18 @@ Features
     - teamspeak2
       TeamSpeak2 server statistics.
 
     - teamspeak2
       TeamSpeak2 server statistics.
 

+    - ted
+      Plugin to read values from `The Energy Detective' (TED).
+

     - thermal
       Linux ACPI thermal zone information.
 
     - thermal
       Linux ACPI thermal zone information.
 

+    - tokyotyrant
+      Record in and file size of a Tokyo Cabinet database file.
+
+    - uptime
+      System uptime statistics.
+

     - users
       Users currently logged in.
 
     - users
       Users currently logged in.
 


@@ -250,13 +298,6 @@ 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.
 

-  * Filtering and rewriting values dispatched to collectd can be done by the
-    following plugins:
-
-    - filter_pcre
-      Filter and rewrite value lists based on Perl-compatible regular
-      expressions.
-

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


@@ -296,6 +337,30 @@ Features
       Notifications are propagated to plugins written in Perl as well.
       See collectd-perl(5).
 
       Notifications are propagated to plugins written in Perl as well.
       See collectd-perl(5).
 

+  * Value processing can be controlled using the "filter chain" infrastructure
+    and "matches" and "targets". The following plugins are available:
+
+    - match_empty_counter
+      Match counter values which are currently zero.
+
+    - match_regex
+      Match values by their identifier based on regular expressions.
+
+    - match_timediff
+      Match values with an invalid timestamp.
+
+    - match_value
+      Select values by their data sources' values.
+
+    - target_notification
+      Create and dispatch a notification.
+
+    - target_replace
+      Replace parts of an identifier using regular expressions.
+
+    - target_set
+      Set (overwrite) entire parts of an identifier.
+

   * Miscellaneous plugins:
 
     - uuid
   * Miscellaneous plugins:
 
     - uuid


@@ -372,8 +437,11 @@ Prerequisites
     particular.
     <http://developer.apple.com/corefoundation/>
 
     particular.
     <http://developer.apple.com/corefoundation/>
 

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

   * libcurl (optional)
   * libcurl (optional)

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

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


@@ -384,6 +452,12 @@ Prerequisites
     For the `notify_email' plugin.
     <http://www.stafford.uklinux.net/libesmtp/>
 
     For the `notify_email' plugin.
     <http://www.stafford.uklinux.net/libesmtp/>
 

+  * libganglia (optional)
+    Used by the `gmond' plugin to process data received from Ganglia.
+
+  * libgcrypt (optional)
+    Used by the `network' plugin for encryption and authentication.
+

   * libhal (optional)
     If present, the uuid plugin will check for UUID from HAL.
     <http://hal.freedesktop.org/>
   * libhal (optional)
     If present, the uuid plugin will check for UUID from HAL.
     <http://hal.freedesktop.org/>


@@ -393,6 +467,14 @@ Prerequisites
     For querying iptables counters.
     <http://netfilter.org/>
 
     For querying iptables counters.
     <http://netfilter.org/>
 

+  * 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
+    libjvm” below.
+
+  * libmemcached (optional)
+    Used by the `memcachec' plugin to connect to a memcache daemon.
+

   * libmysqlclient (optional)
     Unsurprisingly used by the `mysql' plugin.
     <http://dev.mysql.com/>
   * libmysqlclient (optional)
     Unsurprisingly used by the `mysql' plugin.
     <http://dev.mysql.com/>


@@ -423,10 +505,6 @@ 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/>
 

-  * libpcre (optional)
-    Used by the `filter_pcre' plugin.
-    <http://www.pcre.org/>
-

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


@@ -470,6 +548,9 @@ Prerequisites
   * libxmms (optional)
     <http://www.xmms.org/>
 
   * libxmms (optional)
     <http://www.xmms.org/>
 

+  * libyajl (optional)
+    Parse JSON data. This is needed for the `couchdb' plugin.
+    <http://www.lloydforge.org/projects/yajl/>

 
 Configuring / Compiling / Installing
 ------------------------------------
 
 Configuring / Compiling / Installing
 ------------------------------------


@@ -484,10 +565,16 @@ Configuring / Compiling / Installing
   will be enabled). To enable a plugin, install missing dependencies (see
   section `Prerequisites' above) and rerun `configure'. If you specify the
   `--enable-<plugin>' configure option, the script will fail if the depen-
   will be enabled). To enable a plugin, install missing dependencies (see
   section `Prerequisites' above) and rerun `configure'. If you specify the
   `--enable-<plugin>' configure option, the script will fail if the depen-

-  dencies for the specified plugin are not met. If you specify the
-  `--disable-<plugin>' configure option, the plugin will not be built. Both
-  options are meant for package maintainers and should not be used in everyday
-  situations.
+  dencies for the specified plugin are not met. In that case you can force the
+  plugin to be built using the `--enable-<plugin>=force' configure option.
+  This will most likely fail though unless you're working in a very unusual
+  setup and you really know what you're doing. If you specify the
+  `--disable-<plugin>' configure option, the plugin will not be built. If you
+  specify the `--enable-all-plugins' or `--disable-all-plugins' configure
+  options, all plugins will be enabled or disabled respectively by default.
+  Explicitly enabling or disabling a plugin overwrites the default for the
+  specified plugin. These options are meant for package maintainers and should
+  not be used in everyday situations.

 
   By default, collectd will be installed into `/opt/collectd'. You can adjust
   this setting by specifying the `--prefix' configure option - see INSTALL for
 
   By default, collectd will be installed into `/opt/collectd'. You can adjust
   this setting by specifying the `--prefix' configure option - see INSTALL for


@@ -495,6 +582,42 @@ Configuring / Compiling / Installing
   prefixed to all installation directories. This might be useful when creating
   packages for collectd.
 
   prefixed to all installation directories. This might be useful when creating
   packages for collectd.
 

+Configuring with libjvm
+-----------------------
+
+  To determine the location of the required files of a Java installation is not
+  an easy task, because the locations vary with your kernel (Linux, SunOS, …)
+  and with your architecture (x86, SPARC, …) and there is no ‘java-config’
+  script we could use. Configuration of the JVM library is therefore a bit
+  tricky.
+
+  The easiest way to use the `--with-java=$JAVA_HOME' option, where
+  `$JAVA_HOME' is usually something like:
+    /usr/lib/jvm/java-1.5.0-sun-1.5.0.14
+
+  The configure script will then use find(1) to look for the following files:
+
+    - jni.h
+    - jni_md.h
+    - libjvm.so
+
+  If found, appropriate CPP-flags and LD-flags are set and the following
+  library checks succeed.
+
+  If this doesn't work for you, you have the possibility to specify CPP-flags,
+  C-flags and LD-flags for the ‘Java’ plugin by hand, using the following three
+  (environment) variables:
+
+    - JAVA_CPPFLAGS
+    - JAVA_CFLAGS
+    - JAVA_LDFLAGS
+
+  For example (shortened for demonstration purposes):
+
+    ./configure JAVA_CPPFLAGS="-I$JAVA_HOME/include -I$JAVA_HOME/include/linux"
+
+  Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to
+  do that.

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


@@ -514,12 +637,24 @@ Crosscompiling
   that the compiled binary actually behaves as it should, but since NANs
   are likely never passed to the libm you have a good chance to be lucky.
 
   that the compiled binary actually behaves as it should, but since NANs
   are likely never passed to the libm you have a good chance to be lucky.
 

+  Likewise, collectd needs to know the layout of doubles in memory, in order
+  to craft uniform network packets over different architectures. For this, it
+  needs to know how to convert doubles into the memory layout used by x86. The
+  configure script tries to figure this out by compiling and running a few
+  small test programs. This is of course not possible when cross-compiling.
+  You can use the `--with-fp-layout' option to tell the configure script which
+  conversion method to assume. Valid arguments are:
+
+    * `nothing'    (12345678 -> 12345678)
+    * `endianflip' (12345678 -> 87654321)
+    * `intswap'    (12345678 -> 56781234)
+

 
 Contact
 -------
 
 
 Contact
 -------
 

-  For questions, bugreports, development information and basically all other
-  concerns please send an email to collectd's mailinglist 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>.
 
   For live discussion and more personal contact visit us in IRC, we're in
   <collectd at verplant.org>.
 
   For live discussion and more personal contact visit us in IRC, we're in


@@ -533,5 +668,6 @@ Author
   Sebastian tokkee Harl <sh at tokkee.org>,
   and many contributors (see `AUTHORS').
 
   Sebastian tokkee Harl <sh at tokkee.org>,
   and many contributors (see `AUTHORS').
 

-  Please send bugreports and patches to the mailinglist, see `Contact' above.
+  Please send bug reports and patches to the mailing list, see `Contact'
+  above.