X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=0dc7ec91d070f582eab3fa3c2c60ea1a497b9f9d;hb=106e2016957fe53e4d249f1352bb5a7ec9caa76b;hp=ee7163c8b3a9e0d111ca5f6418c66bd7bd6c432c;hpb=b3bfb951c73ea3d232e0e97a42479a5e3310125d;p=collectd.git diff --git a/README b/README index ee7163c8..0dc7ec91 100644 --- a/README +++ b/README @@ -33,9 +33,6 @@ Features 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. @@ -50,6 +47,13 @@ Features - cpufreq CPU frequency (For laptops with speed step or a similar technology) + - curl + Parse statistics from websites using regular expressions. + + - curl_json + Retrieves JSON data via cURL and parses it according to user + configuration. + - dbi Executes SQL statements on various databases and interprets the returned data. @@ -117,6 +121,10 @@ 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). @@ -165,6 +173,10 @@ Features Network UPS tools: UPS current, voltage, power, charge, utilisation, temperature, etc. See upsd(8). + - olsrd + 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. @@ -238,6 +250,10 @@ 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. @@ -258,7 +274,10 @@ Features - xmms Bitrate and frequency of music played with XMMS. - * Output can be written or send to various destinations by the following + - zfs_arc + Statistics for ZFS' “Adaptive Replacement Cache” (ARC). + + * Output can be written or sent to various destinations by the following plugins: - csv @@ -292,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: @@ -334,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. @@ -365,7 +392,7 @@ Features network plugins, makes sure your resources are used efficiently. Also, since collectd is programmed multithreaded it benefits from hyperthreading and multicore processors and makes sure that the daemon isn't idle if only - one plugins waits for an IO-operation to complete. + one plugin waits for an IO-operation to complete. * Once set up, hardly any maintenance is necessary. Setup is kept as easy as possible and the default values should be okay for most users. @@ -432,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) @@ -445,26 +473,35 @@ Prerequisites * 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. + (and others) * libmemcached (optional) Used by the `memcachec' plugin to connect to a memcache daemon. + * libmysqlclient (optional) Unsurprisingly used by the `mysql' plugin. @@ -482,8 +519,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. @@ -524,6 +560,10 @@ Prerequisites and/or Solaris. + * libtokyotyrant (optional) + Used by the tokyotyrant plugin. + + * libupsclient/nut (optional) For the `nut' plugin which queries nut's `upsd'. @@ -539,6 +579,9 @@ Prerequisites * libxmms (optional) + * libyajl (optional) + Parse JSON data. This is needed for the `curl_json' plugin. + Configuring / Compiling / Installing ------------------------------------