Merge branch 'sb/iptables'
[collectd.git] / README
diff --git a/README b/README
index 327d2ef..4a09fee 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
  collectd - System information collection daemon
 =================================================
-http://verplant.org/collectd/
+http://collectd.org/
 
 About
 -----
@@ -14,6 +14,19 @@ Features
 
   * collectd is able to collect the following data:
 
+    - Apache server utilization
+      (Number of bytes transfered, number of requests handled and detailed
+      scoreboard statistics)
+
+    - APC UPS Daemon
+      (UPS charge, load, input/output/battery voltage, etc)
+
+    - Apple Sensors
+      (Temperature, fanspeed and voltage sensors of apple computers)
+
+    - Battery
+      (Charge, current and charge of ACPI and PMU based batteries)
+
     - CPU utilization
       (Time spent in system, user, nice and idle)
 
@@ -26,15 +39,27 @@ Features
     - Disk utilization
       (Sectors read/written, number of read/write actions, time spent doing IO)
 
+    - DNS traffic
+      (query types, response codes, opcodes and traffic)
+
+    - Email statistics
+      (count, traffic, spam scores and checks)
+
     - Harddisk temperatures
       (Uhm, yeah, temperature of harddisks that is ;)
 
     - System load
       (Load average over the last 1, 5 and 15 minutes)
 
+    - mbmon - motherboard monitoring
+      (temperature, fanspeed and voltage information)
+
     - Memory utilization
       (Memory occupied by running processes, page cache, buffer cache and free)
 
+    - Multimeter
+      (Information provided by serial multimeters, such as the «Metex M-4650CR»)
+
     - MySQL server statistics
       (Commands issued, handlers triggered, thread usage, query cache
       utilization and traffic sent/received)
@@ -42,18 +67,21 @@ Features
     - NFS Procedures
       (Which NFS command were called how often. Only NFSv2 and NFSv3 right now)
 
+    - NTP Daemon
+      (Local clock drift, offset to peers, etc)
+
     - Ping latency
       (Time to reach the default gateway or another given host)
 
     - Process counts
       (Number of running, sleeping, zombie, ... processes)
 
+    - Sensors
+      (lm_sensors voltages, temperatures and fan rotation speeds)
+
     - Serial
       (RX and TX of serial interfaces)
 
-    - Sensors
-      (System temperatured and fan rotation speeds)
-
     - Swap
       (Pages swapped out onto harddisk or whatever is called `swap' by the OS..)
 
@@ -69,6 +97,9 @@ Features
     - VServer
       (System ressources used by vservers)
 
+    - Wireless
+      (Link quality of wireless cards)
+
   * Performance: Running as a daemon collectd doesn't spend much time in
     startup. Since collectd links against libping, librrd and libsensors it
     doesn't need to start any other processes.
@@ -99,14 +130,9 @@ Operation
     own experiments.. Some of them require the `RRDs' Perl module.
     (`librrds-perl' on Debian)
 
-  * The RRD-files that collectd creates hold the following data. Use ``rrdtool
-    resize'' if you want to cover longer/shorter periods of time.
-
-    Resolution | Data points |  Timespan
-    -----------+-------------+----------
-    60 seconds |        1500 |  25 hours
-    30 minutes |        1680 |  35 days
-     6 hours   |        1520 | 380 days
+  * The RRAs of the automatically created RRD files depend on the `step'
+    and `heartbeat' settings given on compile time. For a list of the
+    default RRAs take a look in the collectd(1) manpage.
 
 
 Prerequisites
@@ -116,19 +142,35 @@ Prerequisites
 
   * Usual suspects: C compiler, linker, preprocessor, make, ...
 
-  * rrdtool (headers and library; rrdtool 1.0 and 1.2 both work fine)
+  * rrdtool (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 it's values via multicast and not create any RRD files itself.
+    Alternatively you can chose to write CSV-files (Comma Seperated Values)
+    instead.
 
   * libmysqlclient (optional)
 
   * lm-sensors (optional)
 
   * libstatgrab 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..
+    and/or Solaris. Note that CPU- and disk-statistics, while being provided
+    by this library, are not supported in collectd right now..
     <http://www.i-scream.org/libstatgrab/> 
 
+  * libcurl (optional)
+    If you want to use the `apache' plugin
+
+  * librt, libsocket, libkstat, libdevinfo
+    Various standard Solaris libraries which provide system functions.
+
+  * libpthread (optional)
+    For parallelization, especially for plugins that communicate with the
+    outside, e. g. with a socket.
+
+  * CoreFoundation.framework and IOKit.framework
+    For copiling on darwin in general and the `apple_sensors' plugin in
+    particular.
+
 Author
 ------