X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=README;h=e95bae62af26a252b2c01f1c45100570b3225004;hb=8fdf425d52986a519c7d46e9a999bc7b993c7cff;hp=1cfa643492cfad182b161270c26dc67e13f59f8a;hpb=95e95817de3f4962bf87fa1848c483fa27a02a0f;p=collectd.git
diff --git a/README b/README
index 1cfa6434..e95bae62 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,8 +40,8 @@ Features
- conntrack
Number of nf_conntrack entries.
- - couchdb
- Parse statistics from CouchDB JSON documents.
+ - contextswitch
+ Number of context switches done by the operating system.
- cpu
CPU utilization: Time spent in the system, user, nice, idle, and related
@@ -53,6 +50,13 @@ 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.
+
- dbi
Executes SQL statements on various databases and interprets the returned
data.
@@ -120,6 +124,10 @@ Features
- libvirt
CPU, disk and network I/O statistics from virtual machines.
+ - madwifi
+ Queries very detailed usage statistics from wireless LAN adapters and
+ interfaces that use the Atheros chipset and the MadWifi driver.
+
- mbmon
Motherboard sensors: temperature, fanspeed and voltage information,
using mbmon(1).
@@ -143,6 +151,10 @@ Features
MySQL server statistics: Commands issued, handlers triggered, thread
usage, query cache utilization and traffic/octets sent and received.
+ - netapp
+ Plugin to query performance values from a NetApp storage system using the
+ âManage ONTAPâ SDK provided by NetApp.
+
- netlink
Very detailed Linux network interface and routing statistics. You can get
(detailed) information on interfaces, qdiscs, classes, and, if you can
@@ -168,6 +180,10 @@ Features
Network UPS tools: UPS current, voltage, power, charge, utilisation,
temperature, etc. See upsd(8).
+ - olsrd
+ Queries routing information from the âOptimized Link State Routingâ
+ daemon.
+
- onewire (EXPERIMENTAL!)
Read onewire sensors using the owcapu library of the owfs project.
Please read in collectd.conf(5) why this plugin is experimental.
@@ -201,6 +217,12 @@ 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.
+
- rrdcached
RRDtool caching daemon (RRDcacheD) statistics.
@@ -242,7 +264,8 @@ Features
Linux ACPI thermal zone information.
- tokyotyrant
- Record in and file size of a Tokyo Cabinet database file.
+ Reads the number of records and file size from a running Tokyo Tyrant
+ server.
- uptime
System uptime statistics.
@@ -264,6 +287,9 @@ Features
- xmms
Bitrate and frequency of music played with XMMS.
+ - zfs_arc
+ Statistics for ZFS' âAdaptive Replacement Cacheâ (ARC).
+
* Output can be written or send to various destinations by the following
plugins:
@@ -281,6 +307,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
@@ -298,6 +328,11 @@ Features
needed. Please read collectd-unixsock(5) for a description on how that's
done.
+ - write_http
+ Sends the values collected by collectd to a web-server using HTTP POST
+ requests. The transmitted data is either in a form understood by the
+ Exec plugin or formatted in JSON.
+
* Logging is, as everything in collectd, provided by plugins. The following
plugins keep up informed about what's going on:
@@ -308,6 +343,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.
@@ -337,6 +376,10 @@ 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:
@@ -441,7 +484,8 @@ Prerequisites
Used by the `oracle' plugin.
* libcurl (optional)
- If you want to use the `apache', `ascent', `curl' or `nginx' plugin.
+ If you want to use the `apache', `ascent', `curl', `nginx', or `write_http'
+ plugin.
* libdbi (optional)
@@ -454,31 +498,44 @@ 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.
- * libiptc (optional, if not found a version shipped with this distribution
- can be used if the Linux kernel headers are available)
+ * 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
libjvmâ below.
+ (and others)
* libmemcached (optional)
Used by the `memcachec' plugin to connect to a memcache daemon.
+
* libmysqlclient (optional)
Unsurprisingly used by the `mysql' plugin.
+ * libnatapp (optional)
+ Required for the ânetappâ plugin.
+ This library is part of the âManage ONTAP SDKâ published by NetApp.
+
* libnetlink (optional)
Used, obviously, for the `netlink' plugin.
@@ -491,8 +548,7 @@ Prerequisites
For the `notify_desktop' plugin.
- * liboping (optional, if not found a version shipped with this distribution
- can be used)
+ * liboping (optional)
Used by the `ping' plugin to send and receive ICMP packets.
@@ -514,6 +570,14 @@ Prerequisites
The PostgreSQL C client library used by the `postgresql' plugin.
+ * 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,
@@ -533,6 +597,10 @@ Prerequisites
and/or Solaris.
+ * libtokyotyrant (optional)
+ Used by the tokyotyrant plugin.
+
+
* libupsclient/nut (optional)
For the `nut' plugin which queries nut's `upsd'.
@@ -549,8 +617,8 @@ Prerequisites
* libyajl (optional)
- Parse JSON data. This is needed for the `couchdb' plugin.
-
+ Parse JSON data. This is needed for the `curl_json' plugin.
+
Configuring / Compiling / Installing
------------------------------------