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