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     - ascent
  30       Statistics about Ascent, a free server for the game `World of Warcraft'.
  31
  32     - battery
  33       Batterycharge, -current and voltage of ACPI and PMU based laptop
  34       batteries.
  35
  36     - curl
  37       Parse statistics from websites using regular expressions.
  38
  39     - bind
  40       Name server and resolver statistics from the `statistics-channel'
  41       interface of BIND 9.5, 9,6 and later.
  42
  43     - cpu
  44       CPU utilization: Time spent in the system, user, nice, idle, and related
  45       states.
  46
  47     - cpufreq
  48       CPU frequency (For laptops with speed step or a similar technology)
  49
  50     - dbi
  51       Executes SQL statements on various databases and interprets the returned
  52       data.
  53
  54     - df
  55       Mountpoint usage (Basically the values `df(1)' delivers)
  56
  57     - disk
  58       Disk utilization: Sectors read/written, number of read/write actions,
  59       average time an IO-operation took to complete.
  60
  61     - dns
  62       DNS traffic: Query types, response codes, opcodes and traffic/octets
  63       transfered.
  64
  65     - email
  66       Email statistics: Count, traffic, spam scores and checks.
  67       See collectd-email(5).
  68
  69     - entropy
  70       Amount of entropy available to the system.
  71
  72     - exec
  73       Values gathered by a custom program or script.
  74       See collectd-exec(5).
  75
  76     - filecount
  77       Count the number of files in directories.
  78
  79     - hddtemp
  80       Harddisk temperatures using hddtempd.
  81
  82     - interface
  83       Interface traffic: Number of octets, packets and errors for each
  84       interface.
  85
  86     - iptables
  87       Iptables' counters: Number of bytes that were matched by a certain
  88       iptables rule.
  89
  90     - ipmi
  91       IPMI (Intelligent Platform Management Interface) sensors information.
  92
  93     - ipvs
  94       IPVS connection statistics (number of connections, octets and packets
  95       for each service and destination).
  96       See http://www.linuxvirtualserver.org/software/index.html.
  97
  98     - irq
  99       IRQ counters: Frequency in which certain interrupts occur.
 100
 101     - load
 102       System load average over the last 1, 5 and 15 minutes.
 103
 104     - libvirt
 105       CPU, disk and network I/O statistics from virtual machines.
 106
 107     - mbmon
 108       Motherboard sensors: temperature, fanspeed and voltage information,
 109       using mbmon(1).
 110
 111     - memcached
 112       Statistics of the memcached distributed caching system.
 113       <http://www.danga.com/memcached/>
 114
 115     - memory
 116       Memory utilization: Memory occupied by running processes, page cache,
 117       buffer cache and free.
 118
 119     - multimeter
 120       Information provided by serial multimeters, such as the `Metex
 121       M-4650CR'.
 122
 123     - mysql
 124       MySQL server statistics: Commands issued, handlers triggered, thread
 125       usage, query cache utilization and traffic/octets sent and received.
 126
 127     - netlink
 128       Very detailed Linux network interface and routing statistics. You can get
 129       (detailed) information on interfaces, qdiscs, classes, and, if you can
 130       make use of it, filters.
 131
 132     - network
 133       Receive values that were collected by other hosts. Large setups will
 134       want to collect the data on one dedicated machine, and this is the
 135       plugin of choice for that.
 136
 137     - nfs
 138       NFS Procedures: Which NFS command were called how often. Only NFSv2 and
 139       NFSv3 right now.
 140
 141     - nginx
 142       Collects statistics from `nginx' (speak: engine X), a HTTP and mail
 143       server/proxy.
 144
 145     - ntpd
 146       NTP daemon statistics: Local clock drift, offset to peers, etc.
 147
 148     - nut
 149       Network UPS tools: UPS current, voltage, power, charge, utilisation,
 150       temperature, etc. See upsd(8).
 151
 152     - onewire (EXPERIMENTAL!)
 153       Read onewire sensors using the owcapu library of the owfs project.
 154       Please read in collectd.conf(5) why this plugin is experimental.
 155
 156     - openvpn
 157       RX and TX of each client in openvpn-status.log (status-version 2).
 158       <http://openvpn.net/index.php/documentation/howto.html>
 159
 160     - oracle
 161       Query data from an Oracle database.
 162
 163     - perl
 164       The perl plugin implements a Perl-interpreter into collectd. You can
 165       write your own plugins in Perl and return arbitrary values using this
 166       API. See collectd-perl(5).
 167
 168     - ping
 169       Network latency: Time to reach the default gateway or another given
 170       host.
 171
 172     - postgresql
 173       PostgreSQL database statistics: active server connections, transaction
 174       numbers, block IO, table row manipulations.
 175
 176     - powerdns
 177       PowerDNS name server statistics.
 178
 179     - processes
 180       Process counts: Number of running, sleeping, zombie, ... processes.
 181
 182     - rrdcached
 183       RRDtool caching daemon (RRDcacheD) statistics.
 184
 185     - sensors
 186       System sensors, accessed using lm_sensors: Voltages, temperatures and
 187       fan rotation speeds.
 188
 189     - serial
 190       RX and TX of serial interfaces. Linux only; needs root privileges.
 191
 192     - snmp
 193       Read values from SNMP (Simple Network Management Protocol) enabled
 194       network devices such as switches, routers, thermometers, rack monitoring
 195       servers, etc. See collectd-snmp(5).
 196
 197     - swap
 198       Pages swapped out onto harddisk or whatever is called `swap' by the OS..
 199
 200     - tail
 201       Follows (tails) logfiles, parses them by lines and submits matched
 202       values.
 203
 204     - tape
 205       Bytes and operations read and written on tape devices. Solaris only.
 206
 207     - tcpconns
 208       Number of TCP connections to specific local and remote ports.
 209
 210     - teamspeak2
 211       TeamSpeak2 server statistics.
 212
 213     - thermal
 214       Linux ACPI thermal zone information.
 215
 216     - users
 217       Users currently logged in.
 218
 219     - vmem
 220       Virtual memory statistics, e. g. the number of page-ins/-outs or the
 221       number of pagefaults.
 222
 223     - vserver
 224       System resources used by Linux VServers.
 225       See <http://linux-vserver.org/>.
 226
 227     - wireless
 228       Link quality of wireless cards. Linux only.
 229
 230     - xmms
 231       Bitrate and frequency of music played with XMMS.
 232
 233   * Output can be written or send to various destinations by the following
 234     plugins:
 235
 236     - csv
 237       Write to comma separated values (CSV) files. This needs lots of
 238       diskspace but is extremely portable and can be analysed with almost
 239       every program that can analyse anything. Even Microsoft's Excel..
 240
 241     - network
 242       Send the data to a remote host to save the data somehow. This is useful
 243       for large setups where the data should be saved by a dedicated machine.
 244
 245     - perl
 246       Of course the values are propagated to plugins written in Perl, too, so
 247       you can easily do weird stuff with the plugins we didn't dare think of
 248       ;) See collectd-perl(5).
 249
 250     - rrdcached
 251       Output to round-robin-database (RRD) files using the RRDtool caching
 252       daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
 253       implementation of the caching done by the `rrdtool' plugin.
 254
 255     - rrdtool
 256       Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
 257       This is likely the most popular destination for such values. Since
 258       updates to RRD-files are somewhat expensive this plugin can cache
 259       updates to the files and write a bunch of updates at once, which lessens
 260       system load a lot.
 261
 262     - unixsock
 263       One can query the values from the unixsock plugin whenever they're
 264       needed. Please read collectd-unixsock(5) for a description on how that's
 265       done.
 266
 267   * Filtering and rewriting values dispatched to collectd can be done by the
 268     following plugins:
 269
 270     - filter_pcre
 271       Filter and rewrite value lists based on Perl-compatible regular
 272       expressions.
 273
 274   * Logging is, as everything in collectd, provided by plugins. The following
 275     plugins keep up informed about what's going on:
 276
 277     - logfile
 278       Writes logmessages to a file or STDOUT/STDERR.
 279
 280     - perl
 281       Log messages are propagated to plugins written in Perl as well.
 282       See collectd-perl(5).
 283
 284     - syslog
 285       Logs to the standard UNIX logging mechanism, syslog.
 286
 287   * Notifications can be handled by the following plugins:
 288
 289     - notify_desktop
 290       Send a desktop notification to a notification daemon, as defined in
 291       the Desktop Notification Specification. To actually display the
 292       notifications, notification-daemon is required.
 293       See http://www.galago-project.org/specs/notification/.
 294
 295     - notify_email
 296       Send an E-mail with the notification message to the configured
 297       recipients.
 298
 299     - exec
 300       Execute a program or script to handle the notification.
 301       See collectd-exec(5).
 302
 303     - logfile
 304       Writes the notification message to a file or STDOUT/STDERR.
 305
 306     - network
 307       Send the notification to a remote host to handle it somehow.
 308
 309     - perl
 310       Notifications are propagated to plugins written in Perl as well.
 311       See collectd-perl(5).
 312
 313   * Miscellaneous plugins:
 314
 315     - uuid
 316       Sets the hostname to an unique identifier. This is meant for setups
 317       where each client may migrate to another physical host, possibly going
 318       through one or more name changes in the process.
 319
 320   * Performance: Since collectd is running as a daemon it doesn't spend much
 321     time starting up again and again. With the exception of the exec plugin no
 322     processes are forked. Caching in output plugins, such as the rrdtool and
 323     network plugins, makes sure your resources are used efficiently. Also,
 324     since collectd is programmed multithreaded it benefits from hyperthreading
 325     and multicore processors and makes sure that the daemon isn't idle if only
 326     one plugins waits for an IO-operation to complete.
 327
 328   * Once set up, hardly any maintenance is necessary. Setup is kept as easy
 329     as possible and the default values should be okay for most users.
 330
 331
 332 Operation
 333 ---------
 334
 335   * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
 336     Run `collectd -h' for a list of builtin defaults. See `collectd.conf(5)'
 337     for a list of options and a syntax description.
 338
 339   * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
 340     files. The usual place for these files is beneath `/var/lib/collectd'.
 341
 342   * When using some of the plugins, collectd needs to run as user root, since
 343     only root can do certain things, such as craft ICMP packages needed to ping
 344     other hosts. collectd should NOT be installed setuid root since it can be
 345     used to overwrite valuable files!
 346
 347   * Sample scripts to generate graphs reside in `contrib/' in the source
 348     package or somewhere near `/usr/share/doc/collectd' in most distributions.
 349     Please be aware that those script are meant as a starting point for your
 350     own experiments.. Some of them require the `RRDs' Perl module.
 351     (`librrds-perl' on Debian) If you have written a more sophisticated
 352     solution please share it with us.
 353
 354   * The RRAs of the automatically created RRD files depend on the `step'
 355     and `heartbeat' settings given. If change these settings you may need to
 356     re-create the files, losing all data. Please be aware of that when changing
 357     the values and read the rrdtool(1) manpage thoroughly.
 358
 359
 360 collectd and chkrootkit
 361 -----------------------
 362
 363   If you are using the `dns' plugin chkrootkit(1) will report collectd as a
 364   packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
 365   plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
 366   this case, collectd is a legitimate sniffer and the report should be
 367   considered to be a false positive. However, you might want to check that
 368   this really is collectd and not some other, illegitimate sniffer.
 369
 370
 371 Prerequisites
 372 -------------
 373
 374   To compile collectd from source you will need:
 375
 376   * Usual suspects: C compiler, linker, preprocessor, make, ...
 377
 378   * A POSIX-threads (pthread) implementation.
 379     Since gathering some statistics is slow (network connections, slow devices,
 380     etc) the collectd is parallelized. The POSIX threads interface is being
 381     used and should be found in various implementations for hopefully all
 382     platforms.
 383
 384   * CoreFoundation.framework and IOKit.framework (optional)
 385     For compiling on Darwin in general and the `apple_sensors' plugin in
 386     particular.
 387     <http://developer.apple.com/corefoundation/>
 388
 389   * libclntsh (optional)
 390     Used by the `oracle' plugin.
 391
 392   * libcurl (optional)
 393     If you want to use the `apache', `ascent', `curl' or `nginx' plugin.
 394     <http://curl.haxx.se/>
 395
 396   * libdbi (optional)
 397     Used by the `dbi' plugin to connect to various databases.
 398     <http://libdbi.sourceforge.net/>
 399
 400   * libesmtp (optional)
 401     For the `notify_email' plugin.
 402     <http://www.stafford.uklinux.net/libesmtp/>
 403
 404   * libhal (optional)
 405     If present, the uuid plugin will check for UUID from HAL.
 406     <http://hal.freedesktop.org/>
 407
 408   * libiptc (optional, if not found a version shipped with this distribution
 409     can be used if the Linux kernel headers are available)
 410     For querying iptables counters.
 411     <http://netfilter.org/>
 412
 413   * libmysqlclient (optional)
 414     Unsurprisingly used by the `mysql' plugin.
 415     <http://dev.mysql.com/>
 416
 417   * libnetlink (optional)
 418     Used, obviously, for the `netlink' plugin.
 419     <http://www.linuxfoundation.org/en/Net:Iproute2>
 420
 421   * libnetsnmp (optional)
 422     For the `snmp' plugin.
 423     <http://www.net-snmp.org/>
 424
 425   * libnotify (optional)
 426     For the `notify_desktop' plugin.
 427     <http://www.galago-project.org/>
 428
 429   * liboping (optional, if not found a version shipped with this distribution
 430     can be used)
 431     Used by the `ping' plugin to send and receive ICMP packets.
 432     <http://verplant.org/liboping/>
 433
 434   * libowcapi (optional)
 435     Used by the `onewire' plugin to read values from onewire sensors (or the
 436     owserver(1) daemon).
 437     <http://www.owfs.org/>
 438
 439   * libpcap (optional)
 440     Used to capture packets by the `dns' plugin.
 441     <http://www.tcpdump.org/>
 442
 443   * libpcre (optional)
 444     Used by the `filter_pcre' plugin.
 445     <http://www.pcre.org/>
 446
 447   * libperl (optional)
 448     Obviously used by the `perl' plugin. The library has to be compiled with
 449     ithread support (introduced in Perl 5.6.0).
 450     <http://www.perl.org/>
 451
 452   * libpq (optional)
 453     The PostgreSQL C client library used by the `postgresql' plugin.
 454     <http://www.postgresql.org/>
 455
 456   * librrd (optional)
 457     Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
 458     client support which was added after version 1.3 of RRDtool. Versions 1.0,
 459     1.2 and 1.3 are known to work with the `rrdtool' plugin.
 460     <http://oss.oetiker.ch/rrdtool/>
 461
 462   * librt, libsocket, libkstat, libdevinfo (optional)
 463     Various standard Solaris libraries which provide system functions.
 464     <http://developers.sun.com/solaris/>
 465
 466   * libsensors (optional)
 467     To read from `lm_sensors', see the `sensors' plugin.
 468     <http://www.lm-sensors.org/>
 469
 470   * libstatgrab (optional)
 471     Used by various plugins to collect statistics on systems other than Linux
 472     and/or Solaris.
 473     <http://www.i-scream.org/libstatgrab/>
 474
 475   * libupsclient/nut (optional)
 476     For the `nut' plugin which queries nut's `upsd'.
 477     <http://networkupstools.org/>
 478
 479   * libvirt (optional)
 480     Collect statistics from virtual machines.
 481     <http://libvirt.org/>
 482
 483   * libxml2 (optional)
 484     Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
 485     <http://xmlsoft.org/>
 486
 487   * libxmms (optional)
 488     <http://www.xmms.org/>
 489
 490
 491 Configuring / Compiling / Installing
 492 ------------------------------------
 493
 494   To configure, build and install collectd with the default settings, run
 495   `./configure && make && make install'.  For detailed, generic instructions
 496   see INSTALL. For a complete list of configure options and their description,
 497   run `./configure --help'.
 498
 499   By default, the configure script will check for all build dependencies and
 500   disable all plugins whose requirements cannot be fulfilled (any other plugin
 501   will be enabled). To enable a plugin, install missing dependencies (see
 502   section `Prerequisites' above) and rerun `configure'. If you specify the
 503   `--enable-<plugin>' configure option, the script will fail if the depen-
 504   dencies for the specified plugin are not met. If you specify the
 505   `--disable-<plugin>' configure option, the plugin will not be built. Both
 506   options are meant for package maintainers and should not be used in everyday
 507   situations.
 508
 509   By default, collectd will be installed into `/opt/collectd'. You can adjust
 510   this setting by specifying the `--prefix' configure option - see INSTALL for
 511   details. If you pass DESTDIR=<path> to `make install', <path> will be
 512   prefixed to all installation directories. This might be useful when creating
 513   packages for collectd.
 514
 515
 516 Crosscompiling
 517 --------------
 518
 519   To compile correctly collectd needs to be able to initialize static
 520   variables to NAN (Not A Number). Some C libraries, especially the GNU
 521   libc, have a problem with that.
 522
 523   Luckily, with GCC it's possible to work around that problem: One can define
 524   NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
 525   ``implementation'' the configure script needs to compile and run a short
 526   test program. Obviously running a test program when doing a cross-
 527   compilation is, well, challenging.
 528
 529   If you run into this problem, you can use the `--with-nan-emulation'
 530   configure option to force the use of this implementation. We can't promise
 531   that the compiled binary actually behaves as it should, but since NANs
 532   are likely never passed to the libm you have a good chance to be lucky.
 533
 534
 535 Contact
 536 -------
 537
 538   For questions, bugreports, development information and basically all other
 539   concerns please send an email to collectd's mailinglist at
 540   <collectd at verplant.org>.
 541
 542   For live discussion and more personal contact visit us in IRC, we're in
 543   channel #collectd on freenode.
 544
 545
 546 Author
 547 ------
 548
 549   Florian octo Forster <octo at verplant.org>,
 550   Sebastian tokkee Harl <sh at tokkee.org>,
 551   and many contributors (see `AUTHORS').
 552
 553   Please send bugreports and patches to the mailinglist, see `Contact' above.
 554