X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=60de1edd47edae53f03e52e92fbcd7154793d636;hb=79d834024d69d3b33e0fc4717b6560385b54cdd1;hp=0e2a67728bf22dab5c0b3e28d86ff8da1bb8cfe7;hpb=6e430c3eea4a35438b634ae00fc32052b30ec9ae;p=collectd.git
diff --git a/README b/README
index 0e2a6772..60de1edd 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
@@ -86,6 +87,9 @@ Features
DNS traffic: Query types, response codes, opcodes and traffic/octets
transfered.
+ - drbd
+ Collect individual drbd resource statistics.
+
- email
Email statistics: Count, traffic, spam scores and checks.
See collectd-email(5).
@@ -297,6 +301,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 +432,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 +445,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 +604,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 +629,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 +659,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 +669,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 +680,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 +711,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 +721,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 +748,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 +758,7 @@ Prerequisites
* libtokyotyrant (optional)
- Used by the tokyotyrant plugin.
+ Used by the `tokyotyrant' plugin.
* libupsclient/nut (optional)
@@ -754,18 +770,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