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