bindings/java/: JMXMemory: Add GPL and copyright header.

[collectd.git] / README

diff --git a/README b/README
index 5c9eed0..a0ce764 100644 (file)
--- a/README
+++ b/README
@@ -33,6 +33,13 @@ 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.
+

     - 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 +76,9 @@ Features
     - filecount
       Count the number of files in directories.
 
     - filecount
       Count the number of files in directories.
 

+    - gmond
+      Receive multicast traffic from Ganglia instances.
+

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


@@ -146,6 +156,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 +182,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.
 


@@ -250,13 +270,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 +309,27 @@ 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_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 +406,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)


@@ -423,10 +460,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).


@@ -514,12 +547,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 +578,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.