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