X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=1d83a26d9f1874eed53c28fe18f9955a487e7c97;hb=aa73e1258b820025e1ff04d6fe2cc59696ce1a12;hp=e47493ac23c4acb1f6809f30a138ea7a6d062a8b;hpb=0f74e253aeb26c3b4908fdced0a00c7c1f2ad5cd;p=collectd.git diff --git a/README b/README index e47493ac..1d83a26d 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,8 +40,8 @@ Features - conntrack Number of nf_conntrack entries. - - couchdb - Parse statistics from CouchDB JSON documents. + - contextswitch + Number of context switches done by the operating system. - cpu CPU utilization: Time spent in the system, user, nice, idle, and related @@ -53,6 +50,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. @@ -82,6 +86,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 +124,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 +151,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 +180,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. @@ -195,6 +217,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. @@ -213,6 +244,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 +266,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 +290,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: @@ -266,6 +310,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 @@ -283,6 +331,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: @@ -293,6 +346,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. @@ -322,9 +379,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. @@ -340,6 +407,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. @@ -423,7 +493,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 +505,46 @@ 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. + (and others) + + * libmemcached (optional) + Used by the `memcachec' plugin to connect to a memcache daemon. + * libmysqlclient (optional) Unsurprisingly used by the `mysql' plugin. + * libnetapp (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 +557,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. @@ -487,6 +579,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, @@ -506,6 +606,10 @@ Prerequisites and/or Solaris. + * libtokyotyrant (optional) + Used by the tokyotyrant plugin. + + * libupsclient/nut (optional) For the `nut' plugin which queries nut's `upsd'. @@ -522,8 +626,8 @@ 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 +642,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