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
  18       Apache server utilization: Number of bytes transfered, number of
  19       requests handled and detailed scoreboard statistics
  20
  21     - apcups
  22       APC UPS Daemon: UPS charge, load, input/output/battery voltage, etc.
  23
  24     - apple_sensors
  25       Sensors in Macs running Mac OS X / Darwin: Temperature, fanspeed and
  26       voltage sensors.
  27
  28     - battery
  29       Batterycharge, -current and voltage of ACPI and PMU based laptop
  30       batteries.
  31
  32     - cpu
  33       CPU utilization: Time spent in the system, user, nice, idle, and related
  34       states.
  35
  36     - cpufreq
  37       CPU frequency (For laptops with speed step or a similar technology)
  38
  39     - df
  40       Mountpoint usage (Basically the values `df(1)' delivers)
  41
  42     - disk
  43       Disk utilization: Sectors read/written, number of read/write actions,
  44       average time an IO-operation took to complete.
  45
  46     - dns
  47       DNS traffic: Query types, response codes, opcodes and traffic/octets
  48       transfered.
  49
  50     - email
  51       Email statistics: Count, traffic, spam scores and checks.
  52       See collectd-email(5).
  53
  54     - entropy
  55       Amount of entropy available to the system.
  56
  57     - exec
  58       Values gathered by a custom program or script.
  59       See collectd-exec(5).
  60
  61     - hddtemp
  62       Harddisk temperatures using hddtempd.
  63
  64     - interface
  65       Interface traffic: Number of octets, packets and errors for each
  66       interface.
  67
  68     - iptables
  69       Iptables' counters: Number of bytes that were matched by a certain
  70       iptables rule.
  71
  72     - irq
  73       IRQ counters: Frequency in which certain interrupts occur.
  74
  75     - load
  76       System load average over the last 1, 5 and 15 minutes.
  77
  78     - mbmon
  79       Motherboard sensors: temperature, fanspeed and voltage information,
  80       using mbmon(1).
  81
  82     - memory
  83       Memory utilization: Memory occupied by running processes, page cache,
  84       buffer cache and free.
  85
  86     - multimeter
  87       Information provided by serial multimeters, such as the `Metex
  88       M-4650CR'.
  89
  90     - mysql
  91       MySQL server statistics: Commands issued, handlers triggered, thread
  92       usage, query cache utilization and traffic/octets sent and received.
  93
  94     - netlink
  95       Very detailed Linux network interface and routing statistics. You can get
  96       (detailed) information on interfaces, qdiscs, classes, and, if you can
  97       make use of it, filters.
  98
  99     - network
 100       Receive values that were collected by other hosts. Large setups will
 101       want to collect the data on one dedicated machine, and this is the
 102       plugin of choice for that.
 103
 104     - nfs
 105       NFS Procedures: Which NFS command were called how often. Only NFSv2 and
 106       NFSv3 right now.
 107
 108     - ntp
 109       NTP daemon statistics: Local clock drift, offset to peers, etc.
 110
 111     - nut
 112       Network UPS tools: UPS current, voltage, power, charge, utilisation,
 113       temperature, etc. See upsd(8).
 114
 115     - perl
 116       The perl plugin implements a Perl-interpreter into collectd. You can
 117       write your own plugins in Perl and return arbitrary values using this
 118       API. See collectd-perl(5).
 119
 120       This plugin is still considered to be experimental and subject to change
 121       between minor releases.
 122
 123     - ping
 124       Network latency: Time to reach the default gateway or another given
 125       host.
 126
 127     - processes
 128       Process counts: Number of running, sleeping, zombie, ... processes.
 129
 130     - sensors
 131       System sensors, accessed using lm_sensors: Voltages, temperatures and
 132       fan rotation speeds.
 133
 134     - serial
 135       RX and TX of serial interfaces. Linux only; needs root privileges.
 136
 137     - snmp
 138       Read values from SNMP (Simple Network Management Protocol) enabled
 139       network devices such as switches, routers, thermometers, rack monitoring
 140       servers, etc. See collectd-snmp(5).
 141
 142     - swap
 143       Pages swapped out onto harddisk or whatever is called `swap' by the OS..
 144
 145     - tape
 146       Bytes and operations read and written on tape devices. Solaris only.
 147
 148     - tcpconns
 149       Number of TCP connections to specific local and remote ports.
 150
 151     - users
 152       Users currently logged in.
 153
 154     - vserver
 155       System resources used by Linux VServers.
 156       See <http://linux-vserver.org/>.
 157
 158     - wireless
 159       Link quality of wireless cards. Linux only.
 160
 161     - xmms
 162       Bitrate and frequency of music played with XMMS.
 163
 164   * Output can be written or send to various destinations by the following
 165     plugins:
 166
 167     - csv
 168       Write to comma separated values (CSV) files. This needs lots of
 169       diskspace but is extremely portable and can be analysed with almost
 170       every program that can analyse anything. Even Microsoft's Excel..
 171
 172     - network
 173       Send the data to a remote host to save the data somehow. This is useful
 174       for large setups where the data should be saved by a dedicated machine.
 175
 176     - perl
 177       Of course the values are propagated to plugins written in Perl, too, so
 178       you can easily do weird stuff with the plugins we didn't dare think of
 179       ;) See collectd-perl(5).
 180
 181     - rrdtool
 182       Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
 183       This is likely the most popular destination for such values. Since
 184       updates to RRD-files are somewhat expensive this plugin can cache
 185       updates to the files and write a bunch of updates at once, which lessens
 186       system load a lot.
 187
 188     - unixsock
 189       One can query the values from the unixsock plugin whenever they're
 190       needed. Please read collectd-unixsock(5) for a description on how that's
 191       done.
 192
 193   * Logging is, as everything in collectd, provided by plugins. The following
 194     plugins keep up informed about what's going on:
 195
 196     - logfile
 197       Writes logmessages to a file or STDOUT/STDERR.
 198
 199     - syslog
 200       Logs to the standard UNIX logging mechanism, syslog.
 201
 202   * Performance: Since collectd is running as a daemon it doesn't spend much
 203     time starting up again and again. With the exception of the exec plugin no
 204     processes are forked. Caching in output plugins, such as the rrdtool and
 205     network plugins, makes sure your resources are used efficiently. Also,
 206     since collectd is programmed multithreaded it benefits from hyperthreading
 207     and multicore processors and makes sure that the daemon isn't idle if only
 208     one plugins waits for an IO-operation to complete.
 209
 210   * Once set up, hardly any maintenance is necessary. Setup is kept as easy
 211     as possible and the default values should be okay for most users.
 212
 213
 214 Operation
 215 ---------
 216
 217   * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
 218     Run `collectd -h' for a list of builtin defaults. See `collectd.conf(5)'
 219     for a list of options and a syntax description.
 220
 221   * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
 222     files. The usual place for these files is beneath `/var/lib/collectd'.
 223
 224   * When using some of the plugins, collectd needs to run as user root, since only
 225     root can do certain things, such as craft ICMP packages needed to ping
 226     other hosts. collectd should NOT be installed setuid root since it can be
 227     used to overwrite valuable files!
 228
 229   * Sample scripts to generate graphs reside in `contrib/' in the source
 230     package or somewhere near `/usr/share/doc/collectd' in most distributions.
 231     Please be aware that those script are meant as a starting point for your
 232     own experiments.. Some of them require the `RRDs' Perl module.
 233     (`librrds-perl' on Debian) If you have written a more sophisticated
 234     solution please share it with us.
 235
 236   * The RRAs of the automatically created RRD files depend on the `step'
 237     and `heartbeat' settings given. If change these settings you may need to
 238     re-create the files, losing all data. Please be aware of that when changing
 239     the values and read the rrdtool(1) manpage thoroughly.
 240
 241
 242 Prerequisites
 243 -------------
 244
 245   To compile collectd from source you will need:
 246
 247   * Usual suspects: C compiler, linker, preprocessor, make, ...
 248
 249   * A POSIX-threads (pthread) implementation.
 250     Since gathering some statistics is slow (network connections, slow devices,
 251     etc) the collectd is parallelized. The POSIX threads interface is being
 252     used and should be found in various implementations for hopefully all
 253     platforms.
 254
 255   * libcurl (optional)
 256     If you want to use the `apache' plugin
 257
 258   * libiptc (optional)
 259     For querying iptables counters.
 260
 261   * libmysqlclient (optional)
 262
 263   * libnetlink (optional)
 264
 265   * libnetsnmp (optional)
 266
 267   * liboping (optional, if not found a version shipped with this distribution
 268     can be used)
 269     Used by the `ping' plugin to send and receive ICMP packets.
 270
 271   * libpcap (optional)
 272     Used to capture packets by the `dns' plugin.
 273
 274   * librrd (optional; headers and library; rrdtool 1.0 and 1.2 both work fine)
 275     If built without `librrd' the resulting binary will be `client only', i.e.
 276     will send its values via multicast and not create any RRD files itself.
 277     Alternatively you can chose to write CSV-files (Comma Separated Values)
 278     instead.
 279
 280   * libsensors (optional)
 281     To read from `lm_sensors'.
 282
 283   * libstatgrab may be used to collect statistics on systems other than Linux
 284     and/or Solaris. Note that CPU- and disk-statistics, while being provided
 285     by this library, are not supported in collectd right now..
 286     <http://www.i-scream.org/libstatgrab/>
 287
 288   * libupsclient/nut (optional)
 289     For the `nut' plugin which queries nut's `upsd'.
 290
 291   * libxmms (optional)
 292
 293   * librt, libsocket, libkstat, libdevinfo
 294     Various standard Solaris libraries which provide system functions.
 295
 296   * CoreFoundation.framework and IOKit.framework
 297     For compiling on Darwin in general and the `apple_sensors' plugin in
 298     particular.
 299
 300
 301 Crosscompiling
 302 --------------
 303
 304     To compile correctly collectd needs to be able to initialize static
 305     variables to NAN (Not A Number). Some C libraries, especially the GNU
 306     libc, have a problem with that.
 307
 308     Luckily, with GCC it's possible to work around that problem: One can define
 309     NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
 310     ``implementation'' the configure script needs to compile and run a short
 311     test program. Obviously running a test program when doing a cross-
 312     compilation is, well, challenging.
 313
 314     If you run into this problem, you can use the `--with-nan-emulation'
 315     configure option to force the use of this implementation. We can't promise
 316     that the compiled binary actually behaves as it should, but since NANs
 317     are likely never passed to the libm you have a good chance to be lucky.
 318
 319
 320 Contact
 321 -------
 322
 323   For questions, bugreports, development information and basically all other
 324   concerns please send an email to collectd's mailinglist at
 325   <collectd at verplant.org>.
 326
 327   For live discussion and more personal contact visit us in IRC, we're in
 328   channel #collectd on freenode.
 329
 330
 331 Author
 332 ------
 333
 334   Florian octo Forster <octo at verplant.org>,
 335   Sebastian tokkee Harl <sh at tokkee.org>,
 336   and many contributors (see `AUTHORS').
 337
 338   Please send bugreports and patches to the mailinglist, see `Contact' above.
 339