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