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