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     - email
  86       Email statistics: Count, traffic, spam scores and checks.
  87       See collectd-email(5).
  88
  89     - entropy
  90       Amount of entropy available to the system.
  91
  92     - ethstat
  93       Network interface card statistics.
  94
  95     - exec
  96       Values gathered by a custom program or script.
  97       See collectd-exec(5).
  98
  99     - filecount
 100       Count the number of files in directories.
 101
 102     - fscache
 103       Linux file-system based caching framework statistics.
 104
 105     - gmond
 106       Receive multicast traffic from Ganglia instances.
 107
 108     - hddtemp
 109       Harddisk temperatures using hddtempd.
 110
 111     - interface
 112       Interface traffic: Number of octets, packets and errors for each
 113       interface.
 114
 115     - iptables
 116       Iptables' counters: Number of bytes that were matched by a certain
 117       iptables rule.
 118
 119     - ipmi
 120       IPMI (Intelligent Platform Management Interface) sensors information.
 121
 122     - ipvs
 123       IPVS connection statistics (number of connections, octets and packets
 124       for each service and destination).
 125       See http://www.linuxvirtualserver.org/software/index.html.
 126
 127     - irq
 128       IRQ counters: Frequency in which certain interrupts occur.
 129
 130     - java
 131       Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
 132       bytecode. See “Configuring with libjvm” below.
 133
 134     - load
 135       System load average over the last 1, 5 and 15 minutes.
 136
 137     - lpar
 138       Detailed CPU statistics of the “Logical Partitions” virtualization
 139       technique built into IBM's POWER processors.
 140
 141     - libvirt
 142       CPU, memory, disk and network I/O statistics from virtual machines.
 143
 144     - lvm
 145       Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
 146       “Logical Volume Manager” (LVM).
 147
 148     - madwifi
 149       Queries very detailed usage statistics from wireless LAN adapters and
 150       interfaces that use the Atheros chipset and the MadWifi driver.
 151
 152     - mbmon
 153       Motherboard sensors: temperature, fanspeed and voltage information,
 154       using mbmon(1).
 155
 156     - md
 157       Linux software-RAID device information (number of active, failed, spare
 158       and missing disks).
 159
 160     - memcachec
 161       Query and parse data from a memcache daemon (memcached).
 162
 163     - memcached
 164       Statistics of the memcached distributed caching system.
 165       <http://www.danga.com/memcached/>
 166
 167     - memory
 168       Memory utilization: Memory occupied by running processes, page cache,
 169       buffer cache and free.
 170
 171     - mic
 172       Collects CPU usage, memory usage, temperatures and power consumption from
 173       Intel Many Integrated Core (MIC) CPUs.
 174
 175     - modbus
 176       Reads values from Modbus/TCP enabled devices. Supports reading values
 177       from multiple "slaves" so gateway devices can be used.
 178
 179     - multimeter
 180       Information provided by serial multimeters, such as the `Metex
 181       M-4650CR'.
 182
 183     - mysql
 184       MySQL server statistics: Commands issued, handlers triggered, thread
 185       usage, query cache utilization and traffic/octets sent and received.
 186
 187     - netapp
 188       Plugin to query performance values from a NetApp storage system using the
 189       “Manage ONTAP” SDK provided by NetApp.
 190
 191     - netlink
 192       Very detailed Linux network interface and routing statistics. You can get
 193       (detailed) information on interfaces, qdiscs, classes, and, if you can
 194       make use of it, filters.
 195
 196     - network
 197       Receive values that were collected by other hosts. Large setups will
 198       want to collect the data on one dedicated machine, and this is the
 199       plugin of choice for that.
 200
 201     - nfs
 202       NFS Procedures: Which NFS command were called how often. Only NFSv2 and
 203       NFSv3 right now.
 204
 205     - nginx
 206       Collects statistics from `nginx' (speak: engine X), a HTTP and mail
 207       server/proxy.
 208
 209     - ntpd
 210       NTP daemon statistics: Local clock drift, offset to peers, etc.
 211
 212     - nut
 213       Network UPS tools: UPS current, voltage, power, charge, utilisation,
 214       temperature, etc. See upsd(8).
 215
 216     - numa
 217       Information about Non-Uniform Memory Access (NUMA).
 218
 219     - olsrd
 220       Queries routing information from the “Optimized Link State Routing”
 221       daemon.
 222
 223     - onewire (EXPERIMENTAL!)
 224       Read onewire sensors using the owcapu library of the owfs project.
 225       Please read in collectd.conf(5) why this plugin is experimental.
 226
 227     - openvpn
 228       RX and TX of each client in openvpn-status.log (status-version 2).
 229       <http://openvpn.net/index.php/documentation/howto.html>
 230
 231     - oracle
 232       Query data from an Oracle database.
 233
 234     - perl
 235       The perl plugin implements a Perl-interpreter into collectd. You can
 236       write your own plugins in Perl and return arbitrary values using this
 237       API. See collectd-perl(5).
 238
 239     - pf
 240       Query statistics from BSD's packet filter "pf".
 241
 242     - pinba
 243       Receive and dispatch timing values from Pinba, a profiling extension for
 244       PHP.
 245
 246     - ping
 247       Network latency: Time to reach the default gateway or another given
 248       host.
 249
 250     - postgresql
 251       PostgreSQL database statistics: active server connections, transaction
 252       numbers, block IO, table row manipulations.
 253
 254     - powerdns
 255       PowerDNS name server statistics.
 256
 257     - processes
 258       Process counts: Number of running, sleeping, zombie, ... processes.
 259
 260     - protocols
 261       Counts various aspects of network protocols such as IP, TCP, UDP, etc.
 262
 263     - python
 264       The python plugin implements a Python interpreter into collectd. This
 265       makes it possible to write plugins in Python which are executed by
 266       collectd without the need to start a heavy interpreter every interval.
 267       See collectd-python(5) for details.
 268
 269     - redis
 270       The redis plugin gathers information from a redis server, including:
 271       uptime, used memory, total connections etc.
 272
 273     - routeros
 274       Query interface and wireless registration statistics from RouterOS.
 275
 276     - rrdcached
 277       RRDtool caching daemon (RRDcacheD) statistics.
 278
 279     - sensors
 280       System sensors, accessed using lm_sensors: Voltages, temperatures and
 281       fan rotation speeds.
 282
 283     - serial
 284       RX and TX of serial interfaces. Linux only; needs root privileges.
 285
 286     - sigrok
 287       Uses libsigrok as a backend, allowing any sigrok-supported device
 288       to have its measurements fed to collectd. This includes multimeters,
 289       sound level meters, thermometers, and much more.
 290
 291     - snmp
 292       Read values from SNMP (Simple Network Management Protocol) enabled
 293       network devices such as switches, routers, thermometers, rack monitoring
 294       servers, etc. See collectd-snmp(5).
 295
 296     - swap
 297       Pages swapped out onto harddisk or whatever is called `swap' by the OS..
 298
 299     - table
 300       Parse table-like structured files.
 301
 302     - tail
 303       Follows (tails) logfiles, parses them by lines and submits matched
 304       values.
 305
 306     - tail_csv
 307       Follows (tails) files in CSV format, parses each line and submits
 308       extracted values.
 309
 310     - tape
 311       Bytes and operations read and written on tape devices. Solaris only.
 312
 313     - tcpconns
 314       Number of TCP connections to specific local and remote ports.
 315
 316     - teamspeak2
 317       TeamSpeak2 server statistics.
 318
 319     - ted
 320       Plugin to read values from `The Energy Detective' (TED).
 321
 322     - thermal
 323       Linux ACPI thermal zone information.
 324
 325     - tokyotyrant
 326       Reads the number of records and file size from a running Tokyo Tyrant
 327       server.
 328
 329     - uptime
 330       System uptime statistics.
 331
 332     - users
 333       Users currently logged in.
 334
 335     - varnish
 336       Various statistics from Varnish, an HTTP accelerator.
 337
 338     - vmem
 339       Virtual memory statistics, e. g. the number of page-ins/-outs or the
 340       number of pagefaults.
 341
 342     - vserver
 343       System resources used by Linux VServers.
 344       See <http://linux-vserver.org/>.
 345
 346     - wireless
 347       Link quality of wireless cards. Linux only.
 348
 349     - xmms
 350       Bitrate and frequency of music played with XMMS.
 351
 352     - zfs_arc
 353       Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
 354
 355   * Output can be written or sent to various destinations by the following
 356     plugins:
 357
 358     - amqp
 359       Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
 360       server, such as RabbitMQ.
 361
 362     - csv
 363       Write to comma separated values (CSV) files. This needs lots of
 364       diskspace but is extremely portable and can be analysed with almost
 365       every program that can analyse anything. Even Microsoft's Excel..
 366
 367     - network
 368       Send the data to a remote host to save the data somehow. This is useful
 369       for large setups where the data should be saved by a dedicated machine.
 370
 371     - perl
 372       Of course the values are propagated to plugins written in Perl, too, so
 373       you can easily do weird stuff with the plugins we didn't dare think of
 374       ;) See collectd-perl(5).
 375
 376     - python
 377       It's possible to implement write plugins in Python using the python
 378       plugin. See collectd-python(5) for details.
 379
 380     - rrdcached
 381       Output to round-robin-database (RRD) files using the RRDtool caching
 382       daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
 383       implementation of the caching done by the `rrdtool' plugin.
 384
 385     - rrdtool
 386       Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
 387       This is likely the most popular destination for such values. Since
 388       updates to RRD-files are somewhat expensive this plugin can cache
 389       updates to the files and write a bunch of updates at once, which lessens
 390       system load a lot.
 391
 392     - unixsock
 393       One can query the values from the unixsock plugin whenever they're
 394       needed. Please read collectd-unixsock(5) for a description on how that's
 395       done.
 396
 397     - write_graphite
 398       Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
 399       can be configured to avoid logging send errors (especially useful when
 400       using UDP).
 401
 402     - write_http
 403       Sends the values collected by collectd to a web-server using HTTP POST
 404       requests. The transmitted data is either in a form understood by the
 405       Exec plugin or formatted in JSON.
 406
 407     - write_kafka
 408       Sends data to Apache Kafka, a distributed queue.
 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://octo.it/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   * librdkafka (optional; also called “rdkafka”)
 706     Used by the Kafka plugin for producing.
 707     <https://github.com/edenhill/librdkafka>
 708
 709   * librouteros (optional)
 710     Used by the `routeros' plugin to connect to a device running `RouterOS'.
 711     <http://octo.it/librouteros/>
 712
 713   * librrd (optional)
 714     Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
 715     client support which was added after version 1.3 of RRDtool. Versions 1.0,
 716     1.2 and 1.3 are known to work with the `rrdtool' plugin.
 717     <http://oss.oetiker.ch/rrdtool/>
 718
 719   * librt, libsocket, libkstat, libdevinfo (optional)
 720     Various standard Solaris libraries which provide system functions.
 721     <http://developers.sun.com/solaris/>
 722
 723   * libsensors (optional)
 724     To read from `lm_sensors', see the `sensors' plugin.
 725     <http://www.lm-sensors.org/>
 726
 727   * libsigrok (optional)
 728     Used by the sigrok plugin. In addition, libsigrok depends on glib,
 729     libzip, and optionally (depending on which drivers are enabled) on
 730     libusb, libftdi and libudev.
 731
 732   * libstatgrab (optional)
 733     Used by various plugins to collect statistics on systems other than Linux
 734     and/or Solaris.
 735     <http://www.i-scream.org/libstatgrab/>
 736
 737   * libtokyotyrant (optional)
 738     Used by the tokyotyrant plugin.
 739     <http://1978th.net/tokyotyrant/>
 740
 741   * libupsclient/nut (optional)
 742     For the `nut' plugin which queries nut's `upsd'.
 743     <http://networkupstools.org/>
 744
 745   * libvirt (optional)
 746     Collect statistics from virtual machines.
 747     <http://libvirt.org/>
 748
 749   * libxml2 (optional)
 750     Parse XML data. This is needed for the `ascent' and `libvirt' plugins.
 751     <http://xmlsoft.org/>
 752
 753   * libxmms (optional)
 754     <http://www.xmms.org/>
 755
 756   * libyajl (optional)
 757     Parse JSON data. This is needed for the `curl_json' plugin.
 758     <http://github.com/lloyd/yajl>
 759
 760   * libvarnish (optional)
 761      Fetches statistics from a Varnish instance. This is needed for the Varnish plugin
 762      <http://varnish-cache.org>
 763
 764 Configuring / Compiling / Installing
 765 ------------------------------------
 766
 767   To configure, build and install collectd with the default settings, run
 768   `./configure && make && make install'.  For detailed, generic instructions
 769   see INSTALL. For a complete list of configure options and their description,
 770   run `./configure --help'.
 771
 772   By default, the configure script will check for all build dependencies and
 773   disable all plugins whose requirements cannot be fulfilled (any other plugin
 774   will be enabled). To enable a plugin, install missing dependencies (see
 775   section `Prerequisites' above) and rerun `configure'. If you specify the
 776   `--enable-<plugin>' configure option, the script will fail if the depen-
 777   dencies for the specified plugin are not met. In that case you can force the
 778   plugin to be built using the `--enable-<plugin>=force' configure option.
 779   This will most likely fail though unless you're working in a very unusual
 780   setup and you really know what you're doing. If you specify the
 781   `--disable-<plugin>' configure option, the plugin will not be built. If you
 782   specify the `--enable-all-plugins' or `--disable-all-plugins' configure
 783   options, all plugins will be enabled or disabled respectively by default.
 784   Explicitly enabling or disabling a plugin overwrites the default for the
 785   specified plugin. These options are meant for package maintainers and should
 786   not be used in everyday situations.
 787
 788   By default, collectd will be installed into `/opt/collectd'. You can adjust
 789   this setting by specifying the `--prefix' configure option - see INSTALL for
 790   details. If you pass DESTDIR=<path> to `make install', <path> will be
 791   prefixed to all installation directories. This might be useful when creating
 792   packages for collectd.
 793
 794 Configuring with libjvm
 795 -----------------------
 796
 797   To determine the location of the required files of a Java installation is not
 798   an easy task, because the locations vary with your kernel (Linux, SunOS, …)
 799   and with your architecture (x86, SPARC, …) and there is no ‘java-config’
 800   script we could use. Configuration of the JVM library is therefore a bit
 801   tricky.
 802
 803   The easiest way to use the `--with-java=$JAVA_HOME' option, where
 804   `$JAVA_HOME' is usually something like:
 805     /usr/lib/jvm/java-1.5.0-sun-1.5.0.14
 806
 807   The configure script will then use find(1) to look for the following files:
 808
 809     - jni.h
 810     - jni_md.h
 811     - libjvm.so
 812
 813   If found, appropriate CPP-flags and LD-flags are set and the following
 814   library checks succeed.
 815
 816   If this doesn't work for you, you have the possibility to specify CPP-flags,
 817   C-flags and LD-flags for the ‘Java’ plugin by hand, using the following three
 818   (environment) variables:
 819
 820     - JAVA_CPPFLAGS
 821     - JAVA_CFLAGS
 822     - JAVA_LDFLAGS
 823
 824   For example (shortened for demonstration purposes):
 825
 826     ./configure JAVA_CPPFLAGS="-I$JAVA_HOME/include -I$JAVA_HOME/include/linux"
 827
 828   Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to
 829   do that.
 830
 831 Crosscompiling
 832 --------------
 833
 834   To compile correctly collectd needs to be able to initialize static
 835   variables to NAN (Not A Number). Some C libraries, especially the GNU
 836   libc, have a problem with that.
 837
 838   Luckily, with GCC it's possible to work around that problem: One can define
 839   NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
 840   ``implementation'' the configure script needs to compile and run a short
 841   test program. Obviously running a test program when doing a cross-
 842   compilation is, well, challenging.
 843
 844   If you run into this problem, you can use the `--with-nan-emulation'
 845   configure option to force the use of this implementation. We can't promise
 846   that the compiled binary actually behaves as it should, but since NANs
 847   are likely never passed to the libm you have a good chance to be lucky.
 848
 849   Likewise, collectd needs to know the layout of doubles in memory, in order
 850   to craft uniform network packets over different architectures. For this, it
 851   needs to know how to convert doubles into the memory layout used by x86. The
 852   configure script tries to figure this out by compiling and running a few
 853   small test programs. This is of course not possible when cross-compiling.
 854   You can use the `--with-fp-layout' option to tell the configure script which
 855   conversion method to assume. Valid arguments are:
 856
 857     * `nothing'    (12345678 -> 12345678)
 858     * `endianflip' (12345678 -> 87654321)
 859     * `intswap'    (12345678 -> 56781234)
 860
 861
 862 Contact
 863 -------
 864
 865   For questions, bug reports, development information and basically all other
 866   concerns please send an email to collectd's mailing list at
 867   <list at collectd.org>.
 868
 869   For live discussion and more personal contact visit us in IRC, we're in
 870   channel #collectd on freenode.
 871
 872
 873 Author
 874 ------
 875
 876   Florian octo Forster <octo at collectd.org>,
 877   Sebastian tokkee Harl <sh at tokkee.org>,
 878   and many contributors (see `AUTHORS').
 879
 880   Please send bug reports and patches to the mailing list, see `Contact'
 881   above.
 882