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