X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=5c9eed036cf9559e17ac1a43c0d94e232a930fe6;hb=422c0afd40606e7f22304ea11086ea9e56da2579;hp=97119ac5ef70336f31e484cc171f44120fe7705b;hpb=10075e6fe3c384b73c2dd398a1435f8d10e56654;p=collectd.git
diff --git a/README b/README
index 97119ac5..5c9eed03 100644
--- a/README
+++ b/README
@@ -40,6 +40,10 @@ Features
- cpufreq
CPU frequency (For laptops with speed step or a similar technology)
+ - dbi
+ Executes SQL statements on various databases and interprets the returned
+ data.
+
- df
Mountpoint usage (Basically the values `df(1)' delivers)
@@ -62,6 +66,9 @@ Features
Values gathered by a custom program or script.
See collectd-exec(5).
+ - filecount
+ Count the number of files in directories.
+
- hddtemp
Harddisk temperatures using hddtempd.
@@ -73,6 +80,9 @@ Features
Iptables' counters: Number of bytes that were matched by a certain
iptables rule.
+ - ipmi
+ IPMI (Intelligent Platform Management Interface) sensors information.
+
- ipvs
IPVS connection statistics (number of connections, octets and packets
for each service and destination).
@@ -132,6 +142,10 @@ Features
Network UPS tools: UPS current, voltage, power, charge, utilisation,
temperature, etc. See upsd(8).
+ - onewire (EXPERIMENTAL!)
+ Read onewire sensors using the owcapu library of the owfs project.
+ Please read in collectd.conf(5) why this plugin is experimental.
+
- perl
The perl plugin implements a Perl-interpreter into collectd. You can
write your own plugins in Perl and return arbitrary values using this
@@ -145,9 +159,15 @@ Features
PostgreSQL database statistics: active server connections, transaction
numbers, block IO, table row manipulations.
+ - powerdns
+ PowerDNS name server statistics.
+
- processes
Process counts: Number of running, sleeping, zombie, ... processes.
+ - rrdcached
+ RRDtool caching daemon (RRDcacheD) statistics.
+
- sensors
System sensors, accessed using lm_sensors: Voltages, temperatures and
fan rotation speeds.
@@ -173,6 +193,12 @@ Features
- tcpconns
Number of TCP connections to specific local and remote ports.
+ - teamspeak2
+ TeamSpeak2 server statistics.
+
+ - thermal
+ Linux ACPI thermal zone information.
+
- users
Users currently logged in.
@@ -207,6 +233,11 @@ Features
you can easily do weird stuff with the plugins we didn't dare think of
;) See collectd-perl(5).
+ - rrdcached
+ Output to round-robin-database (RRD) files using the RRDtool caching
+ daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
+ implementation of the caching done by the `rrdtool' plugin.
+
- rrdtool
Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
This is likely the most popular destination for such values. Since
@@ -219,6 +250,13 @@ Features
needed. Please read collectd-unixsock(5) for a description on how that's
done.
+ * Filtering and rewriting values dispatched to collectd can be done by the
+ following plugins:
+
+ - filter_pcre
+ Filter and rewrite value lists based on Perl-compatible regular
+ expressions.
+
* Logging is, as everything in collectd, provided by plugins. The following
plugins keep up informed about what's going on:
@@ -272,7 +310,7 @@ Features
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.
-
+
* 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.
@@ -332,72 +370,105 @@ Prerequisites
* CoreFoundation.framework and IOKit.framework (optional)
For compiling on Darwin in general and the `apple_sensors' plugin in
particular.
+
* libcurl (optional)
If you want to use the `apache', `ascent', or `nginx' plugin.
+
+
+ * libdbi (optional)
+ Used by the `dbi' plugin to connect to various databases.
+
* libesmtp (optional)
For the `notify_email' plugin.
+
* libhal (optional)
If present, the uuid plugin will check for UUID from HAL.
+
- * libiptc (optional)
+ * libiptc (optional, if not found a version shipped with this distribution
+ can be used if the Linux kernel headers are available)
For querying iptables counters.
+
* libmysqlclient (optional)
Unsurprisingly used by the `mysql' plugin.
+
* libnetlink (optional)
Used, obviously, for the `netlink' plugin.
+
* libnetsnmp (optional)
For the `snmp' plugin.
+
* libnotify (optional)
For the `notify_desktop' plugin.
+
* liboping (optional, if not found a version shipped with this distribution
can be used)
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
+ owserver(1) daemon).
+
* libpcap (optional)
Used to capture packets by the `dns' plugin.
+
+
+ * libpcre (optional)
+ Used by the `filter_pcre' plugin.
+
* libperl (optional)
Obviously used by the `perl' plugin. The library has to be compiled with
ithread support (introduced in Perl 5.6.0).
+
* libpq (optional)
The PostgreSQL C client library used by the `postgresql' plugin.
+
- * librrd (optional; headers and library; rrdtool 1.0 and 1.2 both work fine)
- If built without `librrd' the resulting binary will be `client only', i.e.
- will send its values via multicast and not create any RRD files itself.
- Alternatively you can chose to write CSV-files (Comma Separated Values)
- instead.
+ * 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,
+ 1.2 and 1.3 are known to work with the `rrdtool' plugin.
+
* librt, libsocket, libkstat, libdevinfo (optional)
Various standard Solaris libraries which provide system functions.
+
* libsensors (optional)
To read from `lm_sensors', see the `sensors' plugin.
+
- * libstatgrab (optional) may be used to collect statistics on systems other
- than Linux and/or Solaris. Note that CPU- and disk-statistics, while being
- provided by this library, are not supported in collectd right now..
-
+ * libstatgrab (optional)
+ Used by various plugins to collect statistics on systems other than Linux
+ and/or Solaris.
+
* libupsclient/nut (optional)
For the `nut' plugin which queries nut's `upsd'.
+
* libvirt (optional)
Collect statistics from virtual machines.
+
* libxml2 (optional)
Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
+
* libxmms (optional)
+
Configuring / Compiling / Installing
@@ -407,14 +478,16 @@ Configuring / Compiling / Installing
`./configure && make && make install'. For detailed, generic instructions
see INSTALL. For a complete list of configure options and their description,
run `./configure --help'.
-
+
By default, the configure script will check for all build dependencies and
disable all plugins whose requirements cannot be fulfilled (any other plugin
will be enabled). To enable a plugin, install missing dependencies (see
section `Prerequisites' above) and rerun `configure'. If you specify the
- `--enable-' configure option, you can force the plugin to be built.
- This will most likely fail though unless you're working in a very unusual
- setup and you really know what you're doing.
+ `--enable-' configure option, the script will fail if the depen-
+ dencies for the specified plugin are not met. If you specify the
+ `--disable-' configure option, the plugin will not be built. Both
+ options are meant for package maintainers and should not be used in everyday
+ situations.
By default, collectd will be installed into `/opt/collectd'. You can adjust
this setting by specifying the `--prefix' configure option - see INSTALL for