X-Git-Url: https://git.octo.it/?a=blobdiff_plain;ds=sidebyside;f=README;h=aea155edfcc743a9cf5c5f78a83e5590d7928933;hb=df26df90820a743c9b28bd2c27a4b00c96742b31;hp=56dee295733b0459e38051e029b7ba4937abe2a8;hpb=6973e40350f57e3502d6fc3c9caa80301cfe424f;p=collectd.git
diff --git a/README b/README
index 56dee295..aea155ed 100644
--- a/README
+++ b/README
@@ -69,16 +69,28 @@ Features
Iptables' counters: Number of bytes that were matched by a certain
iptables rule.
+ - ipvs
+ IPVS connection statistics (number of connections, octets and packets
+ for each service and destination).
+ See http://www.linuxvirtualserver.org/software/index.html.
+
- irq
IRQ counters: Frequency in which certain interrupts occur.
- load
System load average over the last 1, 5 and 15 minutes.
+ - libvirt
+ CPU, disk and network I/O statistics from virtual machines.
+
- mbmon
Motherboard sensors: temperature, fanspeed and voltage information,
using mbmon(1).
+ - memcached
+ Statistics of the memcached distributed caching system.
+
+
- memory
Memory utilization: Memory occupied by running processes, page cache,
buffer cache and free.
@@ -105,6 +117,10 @@ Features
NFS Procedures: Which NFS command were called how often. Only NFSv2 and
NFSv3 right now.
+ - nginx
+ Collects statistics from `nginx' (speak: engine X), a HTTP and mail
+ server/proxy.
+
- ntp
NTP daemon statistics: Local clock drift, offset to peers, etc.
@@ -145,6 +161,9 @@ Features
- tape
Bytes and operations read and written on tape devices. Solaris only.
+ - tcpconns
+ Number of TCP connections to specific local and remote ports.
+
- users
Users currently logged in.
@@ -261,16 +280,19 @@ Prerequisites
platforms.
* libcurl (optional)
- If you want to use the `apache' plugin
+ If you want to use the `apache' and/or `nginx' plugins.
* libiptc (optional)
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.
* liboping (optional, if not found a version shipped with this distribution
can be used)
@@ -286,7 +308,7 @@ Prerequisites
instead.
* libsensors (optional)
- To read from `lm_sensors'.
+ To read from `lm_sensors', see the `sensors' plugin.
* libstatgrab may be used to collect statistics on systems other than Linux
and/or Solaris. Note that CPU- and disk-statistics, while being provided
@@ -305,6 +327,32 @@ Prerequisites
For compiling on Darwin in general and the `apple_sensors' plugin in
particular.
+ * libvirt (optional)
+ Collect statistics from virtual machines.
+
+
+Configuring / Compiling / Installing
+------------------------------------
+
+ To configure, build and install collectd with the default settings, run
+ `./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.
+
+ By default, collectd will be installed into `/opt/collectd'. You can adjust
+ this setting by specifying the `--prefix' configure option - see INSTALL for
+ details. If you pass DESTDIR= to `make install', will be
+ prefixed to all installation directories. This might be useful when creating
+ packages for collectd.
+
Crosscompiling
--------------