X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=60de1edd47edae53f03e52e92fbcd7154793d636;hb=d33ec28f9d965ecd598fd1229e7d2f96ef373534;hp=66408a1841405999c3a8e6cf1f4c5f79b9d606a6;hpb=b31c0f22f96123aaba7b895361ab075c6b8d150b;p=collectd.git
diff --git a/README b/README
index 66408a18..60de1edd 100644
--- a/README
+++ b/README
@@ -32,6 +32,11 @@ Features
- ascent
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.
+
- battery
Batterycharge, -current and voltage of ACPI and PMU based laptop
batteries.
@@ -82,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).
@@ -293,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..
@@ -420,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.
@@ -433,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
@@ -589,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)
@@ -614,25 +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.
+
* 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.
@@ -642,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.
@@ -652,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)
@@ -663,9 +680,13 @@ 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.
-
+
* libowcapi (optional)
Used by the `onewire' plugin to read values from onewire sensors (or the
@@ -690,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)
@@ -699,16 +721,17 @@ 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)
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
@@ -725,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.
@@ -735,7 +758,7 @@ Prerequisites
* libtokyotyrant (optional)
- Used by the tokyotyrant plugin.
+ Used by the `tokyotyrant' plugin.
* libupsclient/nut (optional)
@@ -747,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
@@ -864,7 +890,7 @@ Contact
For questions, bug reports, development information and basically all other
concerns please send an email to collectd's mailing list at
- .
+ .
For live discussion and more personal contact visit us in IRC, we're in
channel #collectd on freenode.
@@ -873,7 +899,7 @@ Contact
Author
------
- Florian octo Forster ,
+ Florian octo Forster ,
Sebastian tokkee Harl ,
and many contributors (see `AUTHORS').