X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=d3bab87101e9164ca32697cc0c72a2fac1031600;hb=ee1113650b0b565776fc3d62162d84741e234f05;hp=3da2aaff1f74e01960a7789640803cf004ad9f0d;hpb=407342ee25b7b6e4efefe7c7ee3b74d32f277c45;p=collectd.git

diff --git a/README b/README
index 3da2aaff..d3bab871 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
  collectd - System information collection daemon
 =================================================
-http://verplant.org/collectd/
+http://collectd.org/
 
 About
 -----
@@ -14,12 +14,25 @@ Features
 
   * collectd is able to collect the following data:
 
+    - Apache server utilization
+      (Number of bytes transfered, number of requests handled and detailed
+      scoreboard statistics)
+
+    - 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)
 
     - CPU frequency
       (For laptops with speed step or a similar technology)
 
+    - Mountpoint usage
+      (Basically the values `df(1)' delivers)
+
     - Disk utilization
       (Sectors read/written, number of read/write actions, time spent doing IO)
 
@@ -32,18 +45,25 @@ Features
     - Memory utilization
       (Memory occupied by running processes, page cache, buffer cache and free)
 
+    - MySQL server statistics
+      (Commands issued, handlers triggered, thread usage, query cache
+      utilization and traffic sent/received)
+
     - NFS Procedures
       (Which NFS command were called how often. Only NFSv2 and NFSv3 right now)
 
     - Ping latency
       (Time to reach the default gateway or another given host)
 
-    - Serial
-      (RX and TX of serial interfaces)
+    - Process counts
+      (Number of running, sleeping, zombie, ... processes)
 
     - Sensors
       (System temperatured and fan rotation speeds)
 
+    - Serial
+      (RX and TX of serial interfaces)
+
     - Swap
       (Pages swapped out onto harddisk or whatever is called `swap' by the OS..)
 
@@ -53,6 +73,15 @@ Features
     - Traffic
       (In/Outbound traffic on the interfaces)
 
+    - 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.
@@ -65,12 +94,17 @@ Features
 Operation
 ---------
 
+  * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
+    Run `collectd -h' for a list of builtin defaults. See `collectd.conf(5)'
+    for a list of options and a syntax description.
+
   * When running collectd writes system statistics in RRD-files. Per default
     they reside in `/var/lib/collectd'.
 
-  * collectd needs to run as user root, since only root can craft ICMP
-    packages needed to ping other hosts. collectd should NOT be installed
-    setui root since it can be used to overwrite valuable files..
+  * When using the `ping' plugin collectd needs to run as user root, since only
+    root can craft ICMP packages needed to ping other hosts. collectd should
+    NOT be installed setuid root since it can be used to overwrite valuable
+    files..
 
   * Sample scripts to generate graphs reside in `contrib/' in the source
     package or somewhere near `/usr/share/doc/collectd' in most distributions.
@@ -78,17 +112,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
-
-  * Use `-c' to start in client-, `-s' to start in server-mode. Read the
-    manpage for details.
+  * 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
@@ -102,6 +128,8 @@ Prerequisites
     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.
 
+  * libmysqlclient (optional)
+
   * lm-sensors (optional)
 
   * libstatgrab may be used to collect statistics on systems other than Linux
@@ -109,6 +137,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
 ------