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