From: Marc Fournier Date: Thu, 31 Jul 2014 21:24:07 +0000 (+0200) Subject: README: cleanup & consistency X-Git-Tag: collectd-5.5.0~239 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=0c1024c7372af213ebabac9e08f0255e84a7a303;p=collectd.git README: cleanup & consistency * add 2 plugins missing from plugin list * add 2 libraries missing from prerequisites section * remove reference to bundled libiptc * add a few missing references to plugins in the prerequisites section * consistent quoting of plugin names * wrap lines at column 80 --- diff --git a/README b/README index 0e2a6772..cbf75741 100644 --- a/README +++ b/README @@ -33,8 +33,9 @@ Features Statistics about Ascent, a free server for the game `World of Warcraft'. - barometer - Using digital barometer sensor MPL115A2 or MPL3115 from Freescale provides - absolute barometric pressure, air pressure reduced to sea level and temperature. + Using digital barometer sensor MPL115A2 or MPL3115 from Freescale + provides absolute barometric pressure, air pressure reduced to sea level + and temperature. - battery Batterycharge, -current and voltage of ACPI and PMU based laptop @@ -297,6 +298,10 @@ Features network devices such as switches, routers, thermometers, rack monitoring servers, etc. See collectd-snmp(5). + - statsd + Acts as a StatsD server, reading values sent over the network from StatsD + clients and calculating rates and other aggregates out of these values. + - swap Pages swapped out onto harddisk or whatever is called `swap' by the OS.. @@ -424,7 +429,7 @@ Features plugins keep up informed about what's going on: - logfile - Writes logmessages to a file or STDOUT/STDERR. + Writes log messages to a file or STDOUT/STDERR. - perl Log messages are propagated to plugins written in Perl as well. @@ -437,6 +442,9 @@ Features - syslog Logs to the standard UNIX logging mechanism, syslog. + - log_logstash + Writes log messages formatted as logstash JSON events. + * Notifications can be handled by the following plugins: - notify_desktop @@ -593,12 +601,12 @@ Prerequisites Used by the `oracle' plugin. * libcredis (optional) - Used by the redis plugin. Please note that you require a 0.2.2 version + Used by the `redis' plugin. Please note that you require a 0.2.2 version or higher. * libcurl (optional) - If you want to use the `apache', `ascent', `curl', `nginx', or `write_http' - plugin. + If you want to use the `apache', `ascent', `bind', `curl', `curl_json', + `curl_xml', `nginx', or `write_http' plugin. * libdbi (optional) @@ -618,28 +626,27 @@ Prerequisites * libhal (optional) - If present, the uuid plugin will check for UUID from HAL. + If present, the `uuid' plugin will check for UUID from HAL. * libi2c-dev (optional) - Used for the plugin `barometer', provides just the i2c-dev.h header file for user space i2c development. + Used for the plugin `barometer', provides just the i2c-dev.h header file + for user space i2c development. * 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 + used by the `java' plugin to execute Java bytecode. See “Configuring with libjvm” below. (and others) + * liblvm2 (optional) + Used by the `lvm' plugin. + + * libmemcached (optional) Used by the `memcachec' plugin to connect to a memcache daemon. @@ -649,8 +656,8 @@ Prerequisites * libmodbus (optional) - Used by the “modbus” plugin to communicate with Modbus/TCP devices. The - “modbus” plugin works with version 2.0.3 of the library – due to frequent + Used by the `modbus' plugin to communicate with Modbus/TCP devices. The + `modbus' plugin works with version 2.0.3 of the library – due to frequent API changes other versions may or may not compile cleanly. @@ -659,7 +666,7 @@ Prerequisites * libnetapp (optional) - Required for the “netapp” plugin. + Required for the `netapp' plugin. This library is part of the “Manage ONTAP SDK” published by NetApp. * libnetsnmp (optional) @@ -670,6 +677,10 @@ Prerequisites For the `notify_desktop' plugin. + * libopenipmi (optional) + Used by the `ipmi' plugin to prove IPMI devices. + + * liboping (optional) Used by the `ping' plugin to send and receive ICMP packets. @@ -697,7 +708,8 @@ Prerequisites * libprotobuf-c, protoc-c (optional) Used by the `pinba' plugin to generate a parser for the network packets - sent by the Pinba PHP extension. + sent by the Pinba PHP extension, and by the `write_riemann' plugin to + generate events to be sent to a Riemann server. * libpython (optional) @@ -706,11 +718,12 @@ Prerequisites * librabbitmq (optional; also called “rabbitmq-c”) - Used by the AMQP plugin for AMQP connections, for example to RabbitMQ. + Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ. * librdkafka (optional; also called “rdkafka”) - Used by the Kafka plugin for producing. + Used by the `write_kafka' plugin for producing messages and sending them + to a Kafka broker. * librouteros (optional) @@ -732,7 +745,7 @@ Prerequisites * libsigrok (optional) - Used by the sigrok plugin. In addition, libsigrok depends on glib, + Used by the `sigrok' plugin. In addition, libsigrok depends on glib, libzip, and optionally (depending on which drivers are enabled) on libusb, libftdi and libudev. @@ -742,7 +755,7 @@ Prerequisites * libtokyotyrant (optional) - Used by the tokyotyrant plugin. + Used by the `tokyotyrant' plugin. * libupsclient/nut (optional) @@ -754,18 +767,21 @@ Prerequisites * libxml2 (optional) - Parse XML data. This is needed for the `ascent' and `libvirt' plugins. + Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and + `libvirt' plugins. * libxmms (optional) * libyajl (optional) - Parse JSON data. This is needed for the `curl_json' plugin. + Parse JSON data. This is needed for the `curl_json' and `log_logstash' + plugins. * libvarnish (optional) - Fetches statistics from a Varnish instance. This is needed for the Varnish plugin + Fetches statistics from a Varnish instance. This is needed for the + `varnish' plugin. Configuring / Compiling / Installing