README

   1  collectd - System information collection daemon
   2 =================================================
   3 http://verplant.org/collectd/
   4
   5 About
   6 -----
   7
   8   collectd is a small daemon which collects statistics about a computer's
   9   usage and writes then into RRD files.
  10
  11
  12 Features
  13 --------
  14
  15   * collectd is able to collect the following data:
  16
  17     - CPU utilization
  18       (Time spent in system, user, nice and idle)
  19
  20     - CPU frequency
  21       (For laptops with speed step or a similar technology)
  22
  23     - Disk utilization
  24       (Sectors read/written, number of read/write actions, time spent doing IO)
  25
  26     - Harddisk temperatures
  27       (Uhm, yeah, temperature of harddisks that is ;)
  28
  29     - System load
  30       (Load average over the last 1, 5 and 15 minutes)
  31
  32     - Memory utilization
  33       (Memory occupied by running processes, page cache, buffer cache and free)
  34
  35     - NFS Procedures
  36       (Which NFS command were called how often. Only NFSv2 and NFSv3 right now)
  37
  38     - Ping latency
  39       (Time to reach the default gateway or another given host)
  40
  41     - Serial
  42       (RX and TX of serial interfaces)
  43
  44     - Sensors
  45       (System temperatured and fan rotation speeds)
  46
  47     - Swap
  48       (Pages swapped out onto harddisk or whatever is called `swap' by the OS..)
  49
  50     - Tape
  51       (Read and write bytes and operations on tape devices)
  52
  53     - Traffic
  54       (In/Outbound traffic on the interfaces)
  55
  56     - Users
  57       (Currently logged in users)
  58
  59   * Performance: Running as a daemon collectd doesn't spend much time in
  60     startup. Since collectd links against libping, librrd and libsensors it
  61     doesn't need to start any other processes.
  62
  63   * Hardly any maintenance neccessary and setup is trivial.
  64
  65   * Extremely easy and failsafe network operation possible.
  66
  67
  68 Operation
  69 ---------
  70
  71   * When running collectd writes system statistics in RRD-files. Per default
  72     they reside in `/var/lib/collectd'.
  73
  74   * collectd needs to run as user root, since only root can craft ICMP
  75     packages needed to ping other hosts. collectd should NOT be installed
  76     setui root since it can be used to overwrite valuable files..
  77
  78   * Sample scripts to generate graphs reside in `contrib/' in the source
  79     package or somewhere near `/usr/share/doc/collectd' in most distributions.
  80     Please be aware that those script are meant as a starting point for your
  81     own experiments.. Some of them require the `RRDs' Perl module.
  82     (`librrds-perl' on Debian)
  83
  84   * The RRD-files that collectd creates hold the following data. Use ``rrdtool
  85     resize'' if you want to cover longer/shorter periods of time.
  86
  87     Resolution | Data points |  Timespan
  88     -----------+-------------+----------
  89     60 seconds |        1500 |  25 hours
  90     30 minutes |        1680 |  35 days
  91      6 hours   |        1520 | 380 days
  92
  93   * Use `-c' to start in client-, `-s' to start in server-mode. Read the
  94     manpage for details.
  95
  96
  97 Prerequisites
  98 -------------
  99
 100   To compile collectd from source you will need:
 101
 102   * Usual suspects: C compiler, linker, preprocessor, make, ...
 103
 104   * rrdtool (headers and library; rrdtool 1.0 and 1.2 both work fine)
 105     If built without `librrd' the resulting binary will be `client only', i.e.
 106     will send it's values via multicast and not create any RRD files itself.
 107
 108   * lm-sensors (optional)
 109
 110   * libstatgrab may be used to collect statistics on systems other than Linux
 111     and/or Solaris. Note that CPU- and disk-statistics, while being provided by
 112     this library, are not supported in collectd right now..
 113     <http://www.i-scream.org/libstatgrab/>
 114
 115 Author
 116 ------
 117
 118   Florian octo Forster <octo at verplant.org>
 119