X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=3a56fbedcd8c2082b07cf8c40fd9358b3ddcdf93;hb=e10ed40edcfd48088b53b34eb780cdaaac2062de;hp=ee7163c8b3a9e0d111ca5f6418c66bd7bd6c432c;hpb=568006186417f6b2404790969599f4cd0d2eee22;p=collectd.git diff --git a/README b/README index ee7163c8..3a56fbed 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. @@ -43,6 +40,9 @@ Features - conntrack Number of nf_conntrack entries. + - contextswitch + Number of context switches done by the operating system. + - cpu CPU utilization: Time spent in the system, user, nice, idle, and related states. @@ -50,6 +50,17 @@ 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. + + - curl_xml + Retrieves XML data via cURL and parses it according to user + configuration. + - dbi Executes SQL statements on various databases and interprets the returned data. @@ -117,6 +128,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). @@ -140,6 +155,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 @@ -165,6 +184,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. @@ -198,6 +221,15 @@ Features - protocols Counts various aspects of network protocols such as IP, TCP, UDP, etc. + - python + The python plugin implements a Python interpreter into collectd. This + makes it possible to write plugins in Python which are executed by + collectd without the need to start a heavy interpreter every interval. + See collectd-python(5) for details. + + - routeros + Query interface and wireless registration statistics from RouterOS. + - rrdcached RRDtool caching daemon (RRDcacheD) statistics. @@ -238,6 +270,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,6 +294,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: @@ -275,6 +314,10 @@ Features you can easily do weird stuff with the plugins we didn't dare think of ;) See collectd-perl(5). + - python + It's possible to implement write plugins in Python using the python + plugin. See collectd-python(5) for details. + - rrdcached Output to round-robin-database (RRD) files using the RRDtool caching daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general @@ -292,6 +335,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: @@ -302,6 +350,10 @@ Features Log messages are propagated to plugins written in Perl as well. See collectd-perl(5). + - python + It's possible to implement log plugins in Python using the python plugin. + See collectd-python(5) for details. + - syslog Logs to the standard UNIX logging mechanism, syslog. @@ -331,9 +383,19 @@ Features Notifications are propagated to plugins written in Perl as well. See collectd-perl(5). + - python + It's possible to implement notification plugins in Python using the + python plugin. See collectd-python(5) for details. + * 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_hashed + Match values using a hash function of the hostname. + - match_regex Match values by their identifier based on regular expressions. @@ -349,6 +411,9 @@ Features - target_replace Replace parts of an identifier using regular expressions. + - target_scale + Scale (multiply) values by an arbitrary value. + - target_set Set (overwrite) entire parts of an identifier. @@ -432,7 +497,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,31 +511,44 @@ 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. + * 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. @@ -482,8 +561,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. @@ -505,6 +583,14 @@ Prerequisites The PostgreSQL C client library used by the `postgresql' plugin. + * libpython (optional) + Used by the `python' plugin. Currently, only 2.3 ≦ Python < 3 is supported. + + + * librouteros (optional) + Used by the `routeros' plugin to connect to a device running `RouterOS'. + + * librrd (optional) Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool client support which was added after version 1.3 of RRDtool. Versions 1.0, @@ -524,6 +610,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 +629,9 @@ Prerequisites * libxmms (optional) + * libyajl (optional) + Parse JSON data. This is needed for the `curl_json' plugin. + Configuring / Compiling / Installing ------------------------------------