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