X-Git-Url: https://git.octo.it/?a=blobdiff_plain;ds=sidebyside;f=README;h=6529a9002d306645075b888b0d4d36c744036465;hb=be99a844a40d7037a910d37a894988b807631a6e;hp=a1bf5ff21ec57fa35f53e6e719954b763c868eb8;hpb=f71895576cbd4b488cd66f0c96efb6fd3e7a6faf;p=collectd.git
diff --git a/README b/README
index a1bf5ff2..6529a900 100644
--- a/README
+++ b/README
@@ -43,6 +43,10 @@ Features
- conntrack
Number of nf_conntrack entries.
+ - curl_json
+ Retrieves JSON data via cURL and parses it according to user
+ configuration.
+
- cpu
CPU utilization: Time spent in the system, user, nice, idle, and related
states.
@@ -79,6 +83,9 @@ Features
- filecount
Count the number of files in directories.
+ - fscache
+ Linux file-system based caching framework statistics.
+
- gmond
Receive multicast traffic from Ganglia instances.
@@ -114,10 +121,17 @@ Features
- libvirt
CPU, disk and network I/O statistics from virtual machines.
+ - madwifi
+ Queries very detailed usage statistics from wireless LAN adapters and
+ interfaces that use the Atheros chipset and the MadWifi driver.
+
- mbmon
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.
@@ -159,6 +173,10 @@ Features
Network UPS tools: UPS current, voltage, power, charge, utilisation,
temperature, etc. See upsd(8).
+ - olsr
+ Queries routing information from the âOptimized Link State Routingâ
+ daemon.
+
- onewire (EXPERIMENTAL!)
Read onewire sensors using the owcapu library of the owfs project.
Please read in collectd.conf(5) why this plugin is experimental.
@@ -210,6 +228,9 @@ Features
- 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.
@@ -229,6 +250,13 @@ Features
- thermal
Linux ACPI thermal zone information.
+ - tokyotyrant
+ Reads the number of records and file size from a running Tokyo Tyrant
+ server.
+
+ - uptime
+ System uptime statistics.
+
- users
Users currently logged in.
@@ -246,6 +274,9 @@ Features
- xmms
Bitrate and frequency of music played with XMMS.
+ - zfs_arc
+ Statistics for ZFS' âAdaptive Replacement Cacheâ (ARC).
+
* Output can be written or send to various destinations by the following
plugins:
@@ -280,6 +311,11 @@ Features
needed. Please read collectd-unixsock(5) for a description on how that's
done.
+ - 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.
+
* Logging is, as everything in collectd, provided by plugins. The following
plugins keep up informed about what's going on:
@@ -322,6 +358,9 @@ Features
* 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.
@@ -420,7 +459,8 @@ Prerequisites
Used by the `oracle' plugin.
* libcurl (optional)
- If you want to use the `apache', `ascent', `curl' or `nginx' plugin.
+ If you want to use the `apache', `ascent', `curl', `nginx', or `write_http'
+ plugin.
* libdbi (optional)
@@ -431,20 +471,34 @@ Prerequisites
For the `notify_email' plugin.
+ * 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.
- * libiptc (optional, if not found a version shipped with this distribution
- can be used if the Linux kernel headers are available)
+ * libiptc (optional)
For querying iptables counters.
+ 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
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.
@@ -461,8 +515,7 @@ Prerequisites
For the `notify_desktop' plugin.
- * liboping (optional, if not found a version shipped with this distribution
- can be used)
+ * liboping (optional)
Used by the `ping' plugin to send and receive ICMP packets.
@@ -518,6 +571,9 @@ Prerequisites
* libxmms (optional)
+ * libyajl (optional)
+ Parse JSON data. This is needed for the `curl_json' plugin.
+
Configuring / Compiling / Installing
------------------------------------
@@ -532,10 +588,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-' configure option, the script will fail if the depen-
- dencies for the specified plugin are not met. If you specify the
- `--disable-' 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-=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-' 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