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