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