Code

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