X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=README;h=5063069009e490e245e57e3498f07a61cb3c2cbf;hp=70118ad1be008039ebce551745e422b0eb4a5e6c;hb=491712ab7dd36eb58fba23942f5edf4b76b50361;hpb=6a3f4941a58714a229ec7d1ee26199c2de3a359d diff --git a/README b/README index 70118ad1..50630690 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,9 +40,8 @@ Features - conntrack Number of nf_conntrack entries. - - curl_json - Retrieves JSON data via cURL and parses it according to user - configuration. + - contextswitch + Number of context switches done by the operating system. - cpu CPU utilization: Time spent in the system, user, nice, idle, and related @@ -54,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. @@ -140,6 +147,10 @@ Features Memory utilization: Memory occupied by running processes, page cache, buffer cache and free. + - modbus + Reads values from Modbus/TCP enabled devices. Supports reading values + from multiple "slaves" so gateway devices can be used. + - multimeter Information provided by serial multimeters, such as the `Metex M-4650CR'. @@ -177,7 +188,7 @@ Features Network UPS tools: UPS current, voltage, power, charge, utilisation, temperature, etc. See upsd(8). - - olsr + - olsrd Queries routing information from the “Optimized Link State Routing” daemon. @@ -197,6 +208,10 @@ Features write your own plugins in Perl and return arbitrary values using this API. See collectd-perl(5). + - pinba + Receive and dispatch timing values from Pinba, a profiling extension for + PHP. + - ping Network latency: Time to reach the default gateway or another given host. @@ -220,6 +235,9 @@ Features 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. @@ -287,7 +305,7 @@ Features - zfs_arc Statistics for ZFS' “Adaptive Replacement Cache” (ARC). - * Output can be written or send to various destinations by the following + * Output can be written or sent to various destinations by the following plugins: - csv @@ -383,6 +401,9 @@ Features - 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. @@ -398,6 +419,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. @@ -414,7 +438,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. @@ -495,9 +519,11 @@ 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. @@ -517,15 +543,21 @@ Prerequisites 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. + + + * libmodbus (optional) + Used by the `modbus' plugin to communicate with Modbus/TCP devices. + * libmysqlclient (optional) Unsurprisingly used by the `mysql' plugin. - * libnatapp (optional) + * libnetapp (optional) Required for the “netapp” plugin. This library is part of the “Manage ONTAP SDK” published by NetApp. @@ -554,6 +586,9 @@ Prerequisites Used to capture packets by the `dns' plugin. + * libperfstat (optional) + Used by various plugins to gather statistics under AIX. + * libperl (optional) Obviously used by the `perl' plugin. The library has to be compiled with ithread support (introduced in Perl 5.6.0). @@ -563,10 +598,19 @@ Prerequisites The PostgreSQL C client library used by the `postgresql' plugin. + * libprotobuf-c, protoc-c (optional) + Used by the `pinba' plugin to generate a parser for the network packets + sent by the Pinba PHP extension. + + * 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, @@ -586,6 +630,10 @@ Prerequisites and/or Solaris. + * libtokyotyrant (optional) + Used by the tokyotyrant plugin. + + * libupsclient/nut (optional) For the `nut' plugin which queries nut's `upsd'. @@ -603,7 +651,7 @@ Prerequisites * libyajl (optional) Parse JSON data. This is needed for the `curl_json' plugin. - + Configuring / Compiling / Installing ------------------------------------