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