1 collectd - System information collection daemon
2 =================================================
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
16 * collectd is able to collect the following data:
19 Apache server utilization: Number of bytes transferred, number of
20 requests handled and detailed scoreboard statistics
23 APC UPS Daemon: UPS charge, load, input/output/battery voltage, etc.
26 Sensors in Macs running Mac OS X / Darwin: Temperature, fan speed and
30 Various sensors in the Aquaero 5 water cooling board made by Aquacomputer.
33 Statistics about Ascent, a free server for the game `World of Warcraft'.
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.
41 Batterycharge, -current and voltage of ACPI and PMU based laptop
45 Name server and resolver statistics from the `statistics-channel'
46 interface of BIND 9.5, 9,6 and later.
49 Statistics from the Ceph distributed storage system.
52 CPU accounting information for process groups under Linux.
55 Chrony daemon statistics: Local clock drift, offset to peers, etc.
58 Number of nf_conntrack entries.
61 Number of context switches done by the operating system.
64 CPU utilization: Time spent in the system, user, nice, idle, and related
68 CPU frequency (For laptops with speed step or a similar technology)
71 CPU sleep: Time spent in suspend (For mobile devices which enter suspend automatically)
74 Parse statistics from websites using regular expressions.
77 Retrieves JSON data via cURL and parses it according to user
81 Retrieves XML data via cURL and parses it according to user
85 Executes SQL statements on various databases and interprets the returned
89 Mountpoint usage (Basically the values `df(1)' delivers)
92 Disk utilization: Sectors read/written, number of read/write actions,
93 average time an IO-operation took to complete.
96 DNS traffic: Query types, response codes, opcodes and traffic/octets
100 Collect DPDK interface statistics.
101 See docs/BUILD.dpdkstat.md for detailed build instructions.
104 Collect individual drbd resource statistics.
107 Email statistics: Count, traffic, spam scores and checks.
108 See collectd-email(5).
111 Amount of entropy available to the system.
114 Network interface card statistics.
117 Values gathered by a custom program or script.
118 See collectd-exec(5).
121 File handles statistics.
124 Count the number of files in directories.
127 Linux file-system based caching framework statistics.
130 Receive multicast traffic from Ganglia instances.
133 Monitor gps related data through gpsd.
136 Hard disk temperatures using hddtempd.
139 Report the number of used and free hugepages. More info on
140 hugepages can be found here:
141 https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt.
144 The intel_rdt plugin collects information provided by monitoring features
145 of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
146 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features
147 provide information about utilization of shared resources like last level
148 cache occupancy, local memory bandwidth usage, remote memory bandwidth
149 usage, instructions per clock.
150 <https://01.org/packet-processing/cache-monitoring-technology-memory-bandwidth-monitoring-cache-allocation-technology-code-and-data>
153 Interface traffic: Number of octets, packets and errors for each
157 IPC counters: semaphores used, number of allocated segments in shared
161 IPMI (Intelligent Platform Management Interface) sensors information.
164 Iptables' counters: Number of bytes that were matched by a certain
168 IPVS connection statistics (number of connections, octets and packets
169 for each service and destination).
170 See http://www.linuxvirtualserver.org/software/index.html.
173 IRQ counters: Frequency in which certain interrupts occur.
176 Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
178 See docs/BUILD.java.md for detailed build instructions.
181 System load average over the last 1, 5 and 15 minutes.
184 Detailed CPU statistics of the “Logical Partitions” virtualization
185 technique built into IBM's POWER processors.
188 The Lua plugin implements a Lua interpreter into collectd. This
189 makes it possible to write plugins in Lua which are executed by
190 collectd without the need to start a heavy interpreter every interval.
191 See collectd-lua(5) for details.
194 Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
195 “Logical Volume Manager” (LVM).
198 Queries very detailed usage statistics from wireless LAN adapters and
199 interfaces that use the Atheros chipset and the MadWifi driver.
202 Motherboard sensors: temperature, fan speed and voltage information,
206 Monitor machine check exceptions (hardware errors detected by hardware
207 and reported to software) reported by mcelog and generate appropriate
208 notifications when machine check exceptions are detected.
211 Linux software-RAID device information (number of active, failed, spare
215 Query and parse data from a memcache daemon (memcached).
218 Statistics of the memcached distributed caching system.
219 <http://www.danga.com/memcached/>
222 Memory utilization: Memory occupied by running processes, page cache,
223 buffer cache and free.
226 Collects CPU usage, memory usage, temperatures and power consumption from
227 Intel Many Integrated Core (MIC) CPUs.
230 Reads values from Modbus/TCP enabled devices. Supports reading values
231 from multiple "slaves" so gateway devices can be used.
234 Information provided by serial multimeters, such as the `Metex
238 MySQL server statistics: Commands issued, handlers triggered, thread
239 usage, query cache utilization and traffic/octets sent and received.
242 Plugin to query performance values from a NetApp storage system using the
243 “Manage ONTAP” SDK provided by NetApp.
246 Very detailed Linux network interface and routing statistics. You can get
247 (detailed) information on interfaces, qdiscs, classes, and, if you can
248 make use of it, filters.
251 Receive values that were collected by other hosts. Large setups will
252 want to collect the data on one dedicated machine, and this is the
253 plugin of choice for that.
256 NFS Procedures: Which NFS command were called how often. Only NFSv2 and
260 Collects statistics from `nginx' (speak: engine X), a HTTP and mail
264 NTP daemon statistics: Local clock drift, offset to peers, etc.
267 Information about Non-Uniform Memory Access (NUMA).
270 Network UPS tools: UPS current, voltage, power, charge, utilisation,
271 temperature, etc. See upsd(8).
274 Queries routing information from the “Optimized Link State Routing”
277 - onewire (EXPERIMENTAL!)
278 Read onewire sensors using the owcapu library of the owfs project.
279 Please read in collectd.conf(5) why this plugin is experimental.
282 Read monitoring information from OpenLDAP's cn=Monitor subtree.
285 RX and TX of each client in openvpn-status.log (status-version 2).
286 <http://openvpn.net/index.php/documentation/howto.html>
289 Query data from an Oracle database.
292 The perl plugin implements a Perl-interpreter into collectd. You can
293 write your own plugins in Perl and return arbitrary values using this
294 API. See collectd-perl(5).
297 Query statistics from BSD's packet filter "pf".
300 Receive and dispatch timing values from Pinba, a profiling extension for
304 Network latency: Time to reach the default gateway or another given
308 PostgreSQL database statistics: active server connections, transaction
309 numbers, block IO, table row manipulations.
312 PowerDNS name server statistics.
315 Process counts: Number of running, sleeping, zombie, ... processes.
318 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
321 The python plugin implements a Python interpreter into collectd. This
322 makes it possible to write plugins in Python which are executed by
323 collectd without the need to start a heavy interpreter every interval.
324 See collectd-python(5) for details.
327 The redis plugin gathers information from a Redis server, including:
328 uptime, used memory, total connections etc.
331 Query interface and wireless registration statistics from RouterOS.
334 RRDtool caching daemon (RRDcacheD) statistics.
337 System sensors, accessed using lm_sensors: Voltages, temperatures and
341 RX and TX of serial interfaces. Linux only; needs root privileges.
344 Uses libsigrok as a backend, allowing any sigrok-supported device
345 to have its measurements fed to collectd. This includes multimeters,
346 sound level meters, thermometers, and much more.
349 Collect SMART statistics, notably load cycle count, temperature
353 Read values from SNMP (Simple Network Management Protocol) enabled
354 network devices such as switches, routers, thermometers, rack monitoring
355 servers, etc. See collectd-snmp(5).
358 Acts as a StatsD server, reading values sent over the network from StatsD
359 clients and calculating rates and other aggregates out of these values.
362 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
365 Parse table-like structured files.
368 Follows (tails) log files, parses them by lines and submits matched
372 Follows (tails) files in CSV format, parses each line and submits
376 Bytes and operations read and written on tape devices. Solaris only.
379 Number of TCP connections to specific local and remote ports.
382 TeamSpeak2 server statistics.
385 Plugin to read values from `The Energy Detective' (TED).
388 Linux ACPI thermal zone information.
391 Reads the number of records and file size from a running Tokyo Tyrant
395 Reads CPU frequency and C-state residency on modern Intel
396 turbo-capable processors.
399 System uptime statistics.
402 Users currently logged in.
405 Various statistics from Varnish, an HTTP accelerator.
408 CPU, memory, disk and network I/O statistics from virtual machines.
411 Virtual memory statistics, e.g. the number of page-ins/-outs or the
412 number of pagefaults.
415 System resources used by Linux VServers.
416 See <http://linux-vserver.org/>.
419 Link quality of wireless cards. Linux only.
422 XEN Hypervisor CPU stats.
425 Bitrate and frequency of music played with XMMS.
428 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
431 Measures the percentage of cpu load per container (zone) under Solaris 10
435 Read data from Zookeeper's MNTR command.
437 * Output can be written or sent to various destinations by the following
441 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
442 server, such as RabbitMQ.
445 Write to comma separated values (CSV) files. This needs lots of
446 diskspace but is extremely portable and can be analysed with almost
447 every program that can analyse anything. Even Microsoft's Excel..
450 Send and receive values over the network using the gRPC framework.
453 It's possible to implement write plugins in Lua using the Lua
454 plugin. See collectd-lua(5) for details.
457 Publishes and subscribes to MQTT topics.
460 Send the data to a remote host to save the data somehow. This is useful
461 for large setups where the data should be saved by a dedicated machine.
464 Of course the values are propagated to plugins written in Perl, too, so
465 you can easily do weird stuff with the plugins we didn't dare think of
466 ;) See collectd-perl(5).
469 It's possible to implement write plugins in Python using the python
470 plugin. See collectd-python(5) for details.
473 Output to round-robin-database (RRD) files using the RRDtool caching
474 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
475 implementation of the caching done by the `rrdtool' plugin.
478 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
479 This is likely the most popular destination for such values. Since
480 updates to RRD-files are somewhat expensive this plugin can cache
481 updates to the files and write a bunch of updates at once, which lessens
485 One can query the values from the unixsock plugin whenever they're
486 needed. Please read collectd-unixsock(5) for a description on how that's
490 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
491 can be configured to avoid logging send errors (especially useful when
495 Sends the values collected by collectd to a web-server using HTTP POST
496 requests. The transmitted data is either in a form understood by the
497 Exec plugin or formatted in JSON.
500 Sends data to Apache Kafka, a distributed queue.
503 Writes data to the log
506 Sends data to MongoDB, a NoSQL database.
509 Publish values using an embedded HTTP server, in a format compatible
510 with Prometheus' collectd_exporter.
513 Sends the values to a Redis key-value database server.
516 Sends data to Riemann, a stream processing and monitoring system.
519 Sends data to Sensu, a stream processing and monitoring system, via the
520 Sensu client local TCP socket.
523 Sends data OpenTSDB, a scalable no master, no shared state time series
526 * Logging is, as everything in collectd, provided by plugins. The following
527 plugins keep us informed about what's going on:
530 Writes log messages to a file or STDOUT/STDERR.
533 Log messages are propagated to plugins written in Perl as well.
534 See collectd-perl(5).
537 It's possible to implement log plugins in Python using the python plugin.
538 See collectd-python(5) for details.
541 Logs to the standard UNIX logging mechanism, syslog.
544 Writes log messages formatted as logstash JSON events.
546 * Notifications can be handled by the following plugins:
549 Send a desktop notification to a notification daemon, as defined in
550 the Desktop Notification Specification. To actually display the
551 notifications, notification-daemon is required.
552 See http://www.galago-project.org/specs/notification/.
555 Send an E-mail with the notification message to the configured
559 Submit notifications as passive check results to a local nagios instance.
562 Execute a program or script to handle the notification.
563 See collectd-exec(5).
566 Writes the notification message to a file or STDOUT/STDERR.
569 Send the notification to a remote host to handle it somehow.
572 Notifications are propagated to plugins written in Perl as well.
573 See collectd-perl(5).
576 It's possible to implement notification plugins in Python using the
577 python plugin. See collectd-python(5) for details.
579 * Value processing can be controlled using the "filter chain" infrastructure
580 and "matches" and "targets". The following plugins are available:
582 - match_empty_counter
583 Match counter values which are currently zero.
586 Match values using a hash function of the hostname.
589 Match values by their identifier based on regular expressions.
592 Match values with an invalid timestamp.
595 Select values by their data sources' values.
597 - target_notification
598 Create and dispatch a notification.
601 Replace parts of an identifier using regular expressions.
604 Scale (multiply) values by an arbitrary value.
607 Set (overwrite) entire parts of an identifier.
609 * Miscellaneous plugins:
612 Selects multiple value lists based on patterns or regular expressions
613 and creates new aggregated values lists from those.
616 Checks values against configured thresholds and creates notifications if
617 values are out of bounds. See collectd-threshold(5) for details.
620 Sets the hostname to a unique identifier. This is meant for setups
621 where each client may migrate to another physical host, possibly going
622 through one or more name changes in the process.
624 * Performance: Since collectd is running as a daemon it doesn't spend much
625 time starting up again and again. With the exception of the exec plugin no
626 processes are forked. Caching in output plugins, such as the rrdtool and
627 network plugins, makes sure your resources are used efficiently. Also,
628 since collectd is programmed multithreaded it benefits from hyper-threading
629 and multicore processors and makes sure that the daemon isn't idle if only
630 one plugin waits for an IO-operation to complete.
632 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
633 as possible and the default values should be okay for most users.
639 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
640 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
641 for a list of options and a syntax description.
643 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
644 files. The usual place for these files is beneath `/var/lib/collectd'.
646 * When using some of the plugins, collectd needs to run as user root, since
647 only root can do certain things, such as craft ICMP packages needed to ping
648 other hosts. collectd should NOT be installed setuid root since it can be
649 used to overwrite valuable files!
651 * Sample scripts to generate graphs reside in `contrib/' in the source
652 package or somewhere near `/usr/share/doc/collectd' in most distributions.
653 Please be aware that those script are meant as a starting point for your
654 own experiments.. Some of them require the `RRDs' Perl module.
655 (`librrds-perl' on Debian) If you have written a more sophisticated
656 solution please share it with us.
658 * The RRAs of the automatically created RRD files depend on the `step'
659 and `heartbeat' settings given. If change these settings you may need to
660 re-create the files, losing all data. Please be aware of that when changing
661 the values and read the rrdtool(1) manpage thoroughly.
664 collectd and chkrootkit
665 -----------------------
667 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
668 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
669 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
670 this case, collectd is a legitimate sniffer and the report should be
671 considered to be a false positive. However, you might want to check that
672 this really is collectd and not some other, illegitimate sniffer.
678 To compile collectd from source you will need:
680 * Usual suspects: C compiler, linker, preprocessor, make, ...
682 collectd makes use of some common C99 features, e.g. compound literals and
683 mixed declarations, and therefore requires a C99 compatible compiler.
685 On Debian and Ubuntu, the "build-essential" package should pull in
686 everything that's necessary.
688 * A POSIX-threads (pthread) implementation.
689 Since gathering some statistics is slow (network connections, slow devices,
690 etc) collectd is parallelized. The POSIX threads interface is being
691 used and should be found in various implementations for hopefully all
694 * When building from the Git repository, flex (tokenizer) and bison (parser
695 generator) are required. Release tarballs include the generated files – you
696 don't need these packages in that case.
698 * aerotools-ng (optional)
699 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
700 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
701 nor does it feature an installation routine. Therefore, you need to point
702 collectd's configure script at the source directory of the `aerotools-ng'
704 <https://github.com/lynix/aerotools-ng>
706 * CoreFoundation.framework and IOKit.framework (optional)
707 For compiling on Darwin in general and the `apple_sensors' plugin in
709 <http://developer.apple.com/corefoundation/>
711 * libatasmart (optional)
712 Used by the `smart' plugin.
713 <http://git.0pointer.de/?p=libatasmart.git>
716 The `turbostat' plugin can optionally build Linux Capabilities support,
717 which avoids full privileges requirement (aka. running as root) to read
719 <http://sites.google.com/site/fullycapable/>
721 * libclntsh (optional)
722 Used by the `oracle' plugin.
724 * libhiredis (optional)
725 Used by the redis plugin. Please note that you require a 0.10.0 version
726 or higher. <https://github.com/redis/hiredis>
729 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
730 `curl_xml', `nginx', or `write_http' plugin.
731 <http://curl.haxx.se/>
734 Used by the `dbi' plugin to connect to various databases.
735 <http://libdbi.sourceforge.net/>
737 * libesmtp (optional)
738 For the `notify_email' plugin.
739 <http://www.stafford.uklinux.net/libesmtp/>
741 * libganglia (optional)
742 Used by the `gmond' plugin to process data received from Ganglia.
743 <http://ganglia.info/>
746 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
750 * libgcrypt (optional)
751 Used by the `network' plugin for encryption and authentication.
752 <http://www.gnupg.org/>
755 Used by the `gps' plugin.
756 <http://developer.berlios.de/projects/gpsd/>
758 * libi2c-dev (optional)
759 Used for the plugin `barometer', provides just the i2c-dev.h header file
760 for user space i2c development.
763 For querying iptables counters.
764 <http://netfilter.org/>
767 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
768 used by the `java' plugin to execute Java bytecode.
769 See docs/BUILD.java.md for detailed build instructions.
770 <http://openjdk.java.net/> (and others)
773 Used by the `openldap' plugin.
774 <http://www.openldap.org/>
777 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
778 <https://www.lua.org/>
781 Used by the `lvm' plugin.
782 <ftp://sources.redhat.com/pub/lvm2/>
784 * libmemcached (optional)
785 Used by the `memcachec' plugin to connect to a memcache daemon.
786 <http://tangent.org/552/libmemcached.html>
788 * libmicrohttpd (optional)
789 Used by the write_prometheus plugin to run an http daemon.
790 <http://www.gnu.org/software/libmicrohttpd/>
793 Used by the `netlink' plugin.
794 <http://www.netfilter.org/projects/libmnl/>
796 * libmodbus (optional)
797 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
798 `modbus' plugin works with version 2.0.3 of the library – due to frequent
799 API changes other versions may or may not compile cleanly.
800 <http://www.libmodbus.org/>
802 * libmysqlclient (optional)
803 Unsurprisingly used by the `mysql' plugin.
804 <http://dev.mysql.com/>
806 * libnetapp (optional)
807 Required for the `netapp' plugin.
808 This library is part of the “Manage ONTAP SDK” published by NetApp.
810 * libnetsnmp (optional)
811 For the `snmp' plugin.
812 <http://www.net-snmp.org/>
814 * libnotify (optional)
815 For the `notify_desktop' plugin.
816 <http://www.galago-project.org/>
818 * libopenipmi (optional)
819 Used by the `ipmi' plugin to prove IPMI devices.
820 <http://openipmi.sourceforge.net/>
822 * liboping (optional)
823 Used by the `ping' plugin to send and receive ICMP packets.
824 <http://octo.it/liboping/>
826 * libowcapi (optional)
827 Used by the `onewire' plugin to read values from onewire sensors (or the
829 <http://www.owfs.org/>
832 Used to capture packets by the `dns' plugin.
833 <http://www.tcpdump.org/>
835 * libperfstat (optional)
836 Used by various plugins to gather statistics under AIX.
839 Obviously used by the `perl' plugin. The library has to be compiled with
840 ithread support (introduced in Perl 5.6.0).
841 <http://www.perl.org/>
844 The PostgreSQL C client library used by the `postgresql' plugin.
845 <http://www.postgresql.org/>
848 The PQoS library for Intel(R) Resource Director Technology used by the
850 <https://github.com/01org/intel-cmt-cat>
852 * libprotobuf, protoc 3.0+ (optional)
853 Used by the `grpc' plugin to generate service stubs and code to handle
854 network packets of collectd's protobuf-based network protocol.
855 <https://developers.google.com/protocol-buffers/>
857 * libprotobuf-c, protoc-c (optional)
858 Used by the `pinba' plugin to generate a parser for the network packets
859 sent by the Pinba PHP extension.
860 <http://code.google.com/p/protobuf-c/>
862 * libpython (optional)
863 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
865 <http://www.python.org/>
867 * librabbitmq (optional; also called “rabbitmq-c”)
868 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
869 <http://hg.rabbitmq.com/rabbitmq-c/>
871 * librdkafka (optional; also called “rdkafka”)
872 Used by the `write_kafka' plugin for producing messages and sending them
874 <https://github.com/edenhill/librdkafka>
876 * librouteros (optional)
877 Used by the `routeros' plugin to connect to a device running `RouterOS'.
878 <http://octo.it/librouteros/>
881 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
882 client support which was added after version 1.3 of RRDtool. Versions 1.0,
883 1.2 and 1.3 are known to work with the `rrdtool' plugin.
884 <http://oss.oetiker.ch/rrdtool/>
886 * librt, libsocket, libkstat, libdevinfo (optional)
887 Various standard Solaris libraries which provide system functions.
888 <http://developers.sun.com/solaris/>
890 * libsensors (optional)
891 To read from `lm_sensors', see the `sensors' plugin.
892 <http://www.lm-sensors.org/>
894 * libsigrok (optional)
895 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
896 libzip, and optionally (depending on which drivers are enabled) on
897 libusb, libftdi and libudev.
899 * libstatgrab (optional)
900 Used by various plugins to collect statistics on systems other than Linux
902 <http://www.i-scream.org/libstatgrab/>
904 * libtokyotyrant (optional)
905 Used by the `tokyotyrant' plugin.
906 <http://1978th.net/tokyotyrant/>
908 * libupsclient/nut (optional)
909 For the `nut' plugin which queries nut's `upsd'.
910 <http://networkupstools.org/>
913 Collect statistics from virtual machines.
914 <http://libvirt.org/>
917 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
919 <http://xmlsoft.org/>
922 Used by the `xencpu' plugin.
923 <http://xenbits.xensource.com/>
926 <http://www.xmms.org/>
929 Parse JSON data. This is needed for the `ceph', `curl_json' and
930 `log_logstash' plugins.
931 <http://github.com/lloyd/yajl>
933 * libvarnish (optional)
934 Fetches statistics from a Varnish instance. This is needed for the
936 <http://varnish-cache.org>
938 * riemann-c-client (optional)
939 For the `write_riemann' plugin.
940 <https://github.com/algernon/riemann-c-client>
942 Configuring / Compiling / Installing
943 ------------------------------------
945 To configure, build and install collectd with the default settings, run
946 `./configure && make && make install'. For detailed, generic instructions
947 see INSTALL. For a complete list of configure options and their description,
948 run `./configure --help'.
950 By default, the configure script will check for all build dependencies and
951 disable all plugins whose requirements cannot be fulfilled (any other plugin
952 will be enabled). To enable a plugin, install missing dependencies (see
953 section `Prerequisites' above) and rerun `configure'. If you specify the
954 `--enable-<plugin>' configure option, the script will fail if the depen-
955 dencies for the specified plugin are not met. In that case you can force the
956 plugin to be built using the `--enable-<plugin>=force' configure option.
957 This will most likely fail though unless you're working in a very unusual
958 setup and you really know what you're doing. If you specify the
959 `--disable-<plugin>' configure option, the plugin will not be built. If you
960 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
961 options, all plugins will be enabled or disabled respectively by default.
962 Explicitly enabling or disabling a plugin overwrites the default for the
963 specified plugin. These options are meant for package maintainers and should
964 not be used in everyday situations.
966 By default, collectd will be installed into `/opt/collectd'. You can adjust
967 this setting by specifying the `--prefix' configure option - see INSTALL for
968 details. If you pass DESTDIR=<path> to `make install', <path> will be
969 prefixed to all installation directories. This might be useful when creating
970 packages for collectd.
972 Generating the configure script
973 -------------------------------
975 Collectd ships with a `build.sh' script to generate the `configure'
976 script shipped with releases.
978 To generate the `configure` script, you'll need the following dependencies:
987 The `build.sh' script takes no arguments.
993 To compile correctly collectd needs to be able to initialize static
994 variables to NAN (Not A Number). Some C libraries, especially the GNU
995 libc, have a problem with that.
997 Luckily, with GCC it's possible to work around that problem: One can define
998 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
999 ``implementation'' the configure script needs to compile and run a short
1000 test program. Obviously running a test program when doing a cross-
1001 compilation is, well, challenging.
1003 If you run into this problem, you can use the `--with-nan-emulation'
1004 configure option to force the use of this implementation. We can't promise
1005 that the compiled binary actually behaves as it should, but since NANs
1006 are likely never passed to the libm you have a good chance to be lucky.
1008 Likewise, collectd needs to know the layout of doubles in memory, in order
1009 to craft uniform network packets over different architectures. For this, it
1010 needs to know how to convert doubles into the memory layout used by x86. The
1011 configure script tries to figure this out by compiling and running a few
1012 small test programs. This is of course not possible when cross-compiling.
1013 You can use the `--with-fp-layout' option to tell the configure script which
1014 conversion method to assume. Valid arguments are:
1016 * `nothing' (12345678 -> 12345678)
1017 * `endianflip' (12345678 -> 87654321)
1018 * `intswap' (12345678 -> 56781234)
1024 Please use GitHub to report bugs and submit pull requests:
1025 <https://github.com/collectd/collectd/>.
1026 See CONTRIBUTING.md for details.
1028 For questions, development information and basically all other concerns please
1029 send an email to collectd's mailing list at
1030 <list at collectd.org>.
1032 For live discussion and more personal contact visit us in IRC, we're in
1033 channel #collectd on freenode.
1039 Florian octo Forster <octo at collectd.org>,
1040 Sebastian tokkee Harl <sh at tokkee.org>,
1041 and many contributors (see `AUTHORS').
projects / collectd.git / blob