X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=README;h=ac79ce509429a68caf581ba57ddbecbc25e399a2;hb=bdbde949ad0bd244574efcec596675e1ef889c43;hp=d40fd2f0ab596a42b4aaa5f735d7fc1c0ff4e43c;hpb=b5ed3c9b617ba78a98f3ef279bb3efa325536080;p=collectd.git
diff --git a/README b/README
index d40fd2f0..ac79ce50 100644
--- a/README
+++ b/README
@@ -57,6 +57,10 @@ Features
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.
@@ -121,6 +125,10 @@ Features
- load
System load average over the last 1, 5 and 15 minutes.
+ - lpar
+ Detailed CPU statistics of the âLogical Partitionsâ virtualization
+ technique built into IBM's POWER processors.
+
- libvirt
CPU, disk and network I/O statistics from virtual machines.
@@ -143,6 +151,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'.
@@ -200,6 +212,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.
@@ -217,6 +233,19 @@ 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.
+
+ - redis
+ The redis plugin gathers information from a redis server, including:
+ uptime, used memory, total connections etc.
+
+ - routeros
+ Query interface and wireless registration statistics from RouterOS.
+
- rrdcached
RRDtool caching daemon (RRDcacheD) statistics.
@@ -267,6 +296,9 @@ Features
- users
Users currently logged in.
+ - varnish
+ Various statistics from Varnish, an HTTP accelerator.
+
- vmem
Virtual memory statistics, e. g. the number of page-ins/-outs or the
number of pagefaults.
@@ -284,9 +316,13 @@ 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:
+ - amqp
+ Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
+ server, such as RabbitMQ.
+
- csv
Write to comma separated values (CSV) files. This needs lots of
diskspace but is extremely portable and can be analysed with almost
@@ -301,6 +337,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
@@ -323,6 +363,9 @@ Features
requests. The transmitted data is either in a form understood by the
Exec plugin or formatted in JSON.
+ - write_redis
+ Sends the values to a Redis key-value database server.
+
* Logging is, as everything in collectd, provided by plugins. The following
plugins keep up informed about what's going on:
@@ -333,6 +376,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.
@@ -362,12 +409,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.
@@ -383,11 +437,18 @@ 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.
* Miscellaneous plugins:
+ - threshold
+ Checks values against configured thresholds and creates notifications if
+ values are out of bounds. See collectd-threshold(5) for details.
+
- uuid
Sets the hostname to an unique identifier. This is meant for setups
where each client may migrate to another physical host, possibly going
@@ -399,7 +460,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.
@@ -465,6 +526,10 @@ Prerequisites
* libclntsh (optional)
Used by the `oracle' plugin.
+ * libcredis (optional)
+ 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.
@@ -510,11 +575,17 @@ Prerequisites
Used by the `memcachec' plugin to connect to a memcache daemon.
+ * 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
+ API changes other versions may or may not compile cleanly.
+
+
* 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.
@@ -543,6 +614,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).
@@ -552,6 +626,24 @@ 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, Python 2.3 and later and Python 3
+ are supported.
+
+
+ * librabbitmq (optional; also called ârabbitmq-câ)
+ Used by the AMQP plugin for AMQP connections, for example to RabbitMQ.
+
+
+ * 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,
@@ -594,6 +686,10 @@ Prerequisites
Parse JSON data. This is needed for the `curl_json' plugin.
+ * libvarnish (optional)
+ Fetches statistics from a Varnish instance. This is needed for the Varnish plugin
+
+
Configuring / Compiling / Installing
------------------------------------