README

   1  collectd - System information collection daemon
   2 =================================================
   3 http://collectd.org/
   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     - Apache server utilization
  18       (Number of bytes transfered, number of requests handled and detailed
  19       scoreboard statistics)
  20
  21     - Apple Sensors
  22       (Temperature, fanspeed and voltage sensors of apple computers)
  23
  24     - Battery
  25       (Charge, current and charge of ACPI and PMU based batteries)
  26
  27     - CPU utilization
  28       (Time spent in system, user, nice and idle)
  29
  30     - CPU frequency
  31       (For laptops with speed step or a similar technology)
  32
  33     - Mountpoint usage
  34       (Basically the values `df(1)' delivers)
  35
  36     - Disk utilization
  37       (Sectors read/written, number of read/write actions, time spent doing IO)
  38
  39     - Harddisk temperatures
  40       (Uhm, yeah, temperature of harddisks that is ;)
  41
  42     - System load
  43       (Load average over the last 1, 5 and 15 minutes)
  44
  45     - Memory utilization
  46       (Memory occupied by running processes, page cache, buffer cache and free)
  47
  48     - MySQL server statistics
  49       (Commands issued, handlers triggered, thread usage, query cache
  50       utilization and traffic sent/received)
  51
  52     - NFS Procedures
  53       (Which NFS command were called how often. Only NFSv2 and NFSv3 right now)
  54
  55     - Ping latency
  56       (Time to reach the default gateway or another given host)
  57
  58     - Process counts
  59       (Number of running, sleeping, zombie, ... processes)
  60
  61     - Sensors
  62       (System temperatured and fan rotation speeds)
  63
  64     - Serial
  65       (RX and TX of serial interfaces)
  66
  67     - Swap
  68       (Pages swapped out onto harddisk or whatever is called `swap' by the OS..)
  69
  70     - Tape
  71       (Read and write bytes and operations on tape devices)
  72
  73     - Traffic
  74       (In/Outbound traffic on the interfaces)
  75
  76     - Users
  77       (Currently logged in users)
  78
  79     - VServer
  80       (System ressources used by vservers)
  81
  82     - Wireless
  83       (Link quality of wireless cards)
  84
  85   * Performance: Running as a daemon collectd doesn't spend much time in
  86     startup. Since collectd links against libping, librrd and libsensors it
  87     doesn't need to start any other processes.
  88
  89   * Hardly any maintenance neccessary and setup is trivial.
  90
  91   * Extremely easy and failsafe network operation possible.
  92
  93
  94 Operation
  95 ---------
  96
  97   * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
  98     Run `collectd -h' for a list of builtin defaults. See `collectd.conf(5)'
  99     for a list of options and a syntax description.
 100
 101   * When running collectd writes system statistics in RRD-files. Per default
 102     they reside in `/var/lib/collectd'.
 103
 104   * When using the `ping' plugin collectd needs to run as user root, since only
 105     root can craft ICMP packages needed to ping other hosts. collectd should
 106     NOT be installed setuid root since it can be used to overwrite valuable
 107     files..
 108
 109   * Sample scripts to generate graphs reside in `contrib/' in the source
 110     package or somewhere near `/usr/share/doc/collectd' in most distributions.
 111     Please be aware that those script are meant as a starting point for your
 112     own experiments.. Some of them require the `RRDs' Perl module.
 113     (`librrds-perl' on Debian)
 114
 115   * The RRAs of the automatically created RRD files depend on the `step'
 116     and `heartbeat' settings given on compile time. For a list of the
 117     default RRAs take a look in the collectd(1) manpage.
 118
 119
 120 Prerequisites
 121 -------------
 122
 123   To compile collectd from source you will need:
 124
 125   * Usual suspects: C compiler, linker, preprocessor, make, ...
 126
 127   * rrdtool (headers and library; rrdtool 1.0 and 1.2 both work fine)
 128     If built without `librrd' the resulting binary will be `client only', i.e.
 129     will send it's values via multicast and not create any RRD files itself.
 130
 131   * libmysqlclient (optional)
 132
 133   * lm-sensors (optional)
 134
 135   * libstatgrab may be used to collect statistics on systems other than Linux
 136     and/or Solaris. Note that CPU- and disk-statistics, while being provided by
 137     this library, are not supported in collectd right now..
 138     <http://www.i-scream.org/libstatgrab/>
 139
 140   * libcurl (optional)
 141     If you want to use the `apache' plugin
 142
 143   * CoreFoundation.framework and IOKit.framework
 144     For copiling on darwin in general and the `apple_sensors' plugin in
 145     particular.
 146
 147 Author
 148 ------
 149
 150   Florian octo Forster <octo at verplant.org>
 151