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