README

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