X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=07a7415a00d6dc4ef929762aff433d4ec6087e32;hb=8d3fe5fb26cb6de1ee58cba572cb38ac93e906b2;hp=e47493ac23c4acb1f6809f30a138ea7a6d062a8b;hpb=bc51ef217e871b80152eccd4e5f32659500f75f3;p=collectd.git diff --git a/README b/README index e47493ac..07a7415a 100644 --- a/README +++ b/README @@ -43,8 +43,9 @@ Features - conntrack Number of nf_conntrack entries. - - couchdb - Parse statistics from CouchDB JSON documents. + - 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 @@ -82,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. @@ -117,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. @@ -137,6 +148,10 @@ Features MySQL server statistics: Commands issued, handlers triggered, thread usage, query cache utilization and traffic/octets sent and received. + - netapp + Plugin to query performance values from a NetApp storage system using the + “Manage ONTAP” SDK provided by NetApp. + - netlink Very detailed Linux network interface and routing statistics. You can get (detailed) information on interfaces, qdiscs, classes, and, if you can @@ -162,6 +177,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. @@ -213,6 +232,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. @@ -232,6 +254,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. @@ -249,6 +278,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: @@ -283,6 +315,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: @@ -325,6 +362,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. @@ -423,7 +463,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) @@ -434,24 +475,42 @@ 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. + * libnatapp (optional) + 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. @@ -464,8 +523,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. @@ -522,7 +580,7 @@ Prerequisites * libyajl (optional) - Parse JSON data. This is needed for the `couchdb' plugin. + Parse JSON data. This is needed for the `curl_json' plugin. Configuring / Compiling / Installing @@ -538,10 +596,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