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