network plugin: Changed the old network code to work as a plugin.

[collectd.git] / README

diff --git a/README b/README
index 016a14b..ac1ba15 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)
 
@@ -42,18 +55,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..)
 
@@ -66,6 +82,12 @@ Features
     - Users
       (Currently logged in users)
 
+    - 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.
@@ -96,14 +118,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
@@ -126,6 +143,13 @@ Prerequisites
     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
+
+  * CoreFoundation.framework and IOKit.framework
+    For copiling on darwin in general and the `apple_sensors' plugin in
+    particular.
+
 Author
 ------