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 Linux software-RAID device information (number of active, failed, spare
206 Motherboard sensors: temperature, fan speed and voltage information,
210 Query and parse data from a memcache daemon (memcached).
213 Statistics of the memcached distributed caching system.
214 <http://www.danga.com/memcached/>
217 Memory utilization: Memory occupied by running processes, page cache,
218 buffer cache and free.
221 Collects CPU usage, memory usage, temperatures and power consumption from
222 Intel Many Integrated Core (MIC) CPUs.
225 Reads values from Modbus/TCP enabled devices. Supports reading values
226 from multiple "slaves" so gateway devices can be used.
229 Information provided by serial multimeters, such as the `Metex
233 MySQL server statistics: Commands issued, handlers triggered, thread
234 usage, query cache utilization and traffic/octets sent and received.
237 Plugin to query performance values from a NetApp storage system using the
238 “Manage ONTAP” SDK provided by NetApp.
241 Very detailed Linux network interface and routing statistics. You can get
242 (detailed) information on interfaces, qdiscs, classes, and, if you can
243 make use of it, filters.
246 Receive values that were collected by other hosts. Large setups will
247 want to collect the data on one dedicated machine, and this is the
248 plugin of choice for that.
251 NFS Procedures: Which NFS command were called how often. Only NFSv2 and
255 Collects statistics from `nginx' (speak: engine X), a HTTP and mail
259 NTP daemon statistics: Local clock drift, offset to peers, etc.
262 Information about Non-Uniform Memory Access (NUMA).
265 Network UPS tools: UPS current, voltage, power, charge, utilisation,
266 temperature, etc. See upsd(8).
269 Queries routing information from the “Optimized Link State Routing”
272 - onewire (EXPERIMENTAL!)
273 Read onewire sensors using the owcapu library of the owfs project.
274 Please read in collectd.conf(5) why this plugin is experimental.
277 Read monitoring information from OpenLDAP's cn=Monitor subtree.
280 RX and TX of each client in openvpn-status.log (status-version 2).
281 <http://openvpn.net/index.php/documentation/howto.html>
284 Query data from an Oracle database.
287 The perl plugin implements a Perl-interpreter into collectd. You can
288 write your own plugins in Perl and return arbitrary values using this
289 API. See collectd-perl(5).
292 Query statistics from BSD's packet filter "pf".
295 Receive and dispatch timing values from Pinba, a profiling extension for
299 Network latency: Time to reach the default gateway or another given
303 PostgreSQL database statistics: active server connections, transaction
304 numbers, block IO, table row manipulations.
307 PowerDNS name server statistics.
310 Process counts: Number of running, sleeping, zombie, ... processes.
313 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
316 The python plugin implements a Python interpreter into collectd. This
317 makes it possible to write plugins in Python which are executed by
318 collectd without the need to start a heavy interpreter every interval.
319 See collectd-python(5) for details.
322 The redis plugin gathers information from a Redis server, including:
323 uptime, used memory, total connections etc.
326 Query interface and wireless registration statistics from RouterOS.
329 RRDtool caching daemon (RRDcacheD) statistics.
332 System sensors, accessed using lm_sensors: Voltages, temperatures and
336 RX and TX of serial interfaces. Linux only; needs root privileges.
339 Uses libsigrok as a backend, allowing any sigrok-supported device
340 to have its measurements fed to collectd. This includes multimeters,
341 sound level meters, thermometers, and much more.
344 Collect SMART statistics, notably load cycle count, temperature
348 Read values from SNMP (Simple Network Management Protocol) enabled
349 network devices such as switches, routers, thermometers, rack monitoring
350 servers, etc. See collectd-snmp(5).
353 Acts as a StatsD server, reading values sent over the network from StatsD
354 clients and calculating rates and other aggregates out of these values.
357 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
360 Parse table-like structured files.
363 Follows (tails) log files, parses them by lines and submits matched
367 Follows (tails) files in CSV format, parses each line and submits
371 Bytes and operations read and written on tape devices. Solaris only.
374 Number of TCP connections to specific local and remote ports.
377 TeamSpeak2 server statistics.
380 Plugin to read values from `The Energy Detective' (TED).
383 Linux ACPI thermal zone information.
386 Reads the number of records and file size from a running Tokyo Tyrant
390 Reads CPU frequency and C-state residency on modern Intel
391 turbo-capable processors.
394 System uptime statistics.
397 Users currently logged in.
400 Various statistics from Varnish, an HTTP accelerator.
403 CPU, memory, disk and network I/O statistics from virtual machines.
406 Virtual memory statistics, e.g. the number of page-ins/-outs or the
407 number of pagefaults.
410 System resources used by Linux VServers.
411 See <http://linux-vserver.org/>.
414 Link quality of wireless cards. Linux only.
417 XEN Hypervisor CPU stats.
420 Bitrate and frequency of music played with XMMS.
423 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
426 Measures the percentage of cpu load per container (zone) under Solaris 10
430 Read data from Zookeeper's MNTR command.
432 * Output can be written or sent to various destinations by the following
436 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
437 server, such as RabbitMQ.
440 Write to comma separated values (CSV) files. This needs lots of
441 diskspace but is extremely portable and can be analysed with almost
442 every program that can analyse anything. Even Microsoft's Excel..
445 Send and receive values over the network using the gRPC framework.
448 It's possible to implement write plugins in Lua using the Lua
449 plugin. See collectd-lua(5) for details.
452 Publishes and subscribes to MQTT topics.
455 Send the data to a remote host to save the data somehow. This is useful
456 for large setups where the data should be saved by a dedicated machine.
459 Of course the values are propagated to plugins written in Perl, too, so
460 you can easily do weird stuff with the plugins we didn't dare think of
461 ;) See collectd-perl(5).
464 It's possible to implement write plugins in Python using the python
465 plugin. See collectd-python(5) for details.
468 Output to round-robin-database (RRD) files using the RRDtool caching
469 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
470 implementation of the caching done by the `rrdtool' plugin.
473 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
474 This is likely the most popular destination for such values. Since
475 updates to RRD-files are somewhat expensive this plugin can cache
476 updates to the files and write a bunch of updates at once, which lessens
480 One can query the values from the unixsock plugin whenever they're
481 needed. Please read collectd-unixsock(5) for a description on how that's
485 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
486 can be configured to avoid logging send errors (especially useful when
490 Sends the values collected by collectd to a web-server using HTTP POST
491 requests. The transmitted data is either in a form understood by the
492 Exec plugin or formatted in JSON.
495 Sends data to Apache Kafka, a distributed queue.
498 Writes data to the log
501 Sends data to MongoDB, a NoSQL database.
504 Publish values using an embedded HTTP server, in a format compatible
505 with Prometheus' collectd_exporter.
508 Sends the values to a Redis key-value database server.
511 Sends data to Riemann, a stream processing and monitoring system.
514 Sends data to Sensu, a stream processing and monitoring system, via the
515 Sensu client local TCP socket.
518 Sends data OpenTSDB, a scalable no master, no shared state time series
521 * Logging is, as everything in collectd, provided by plugins. The following
522 plugins keep us informed about what's going on:
525 Writes log messages to a file or STDOUT/STDERR.
528 Log messages are propagated to plugins written in Perl as well.
529 See collectd-perl(5).
532 It's possible to implement log plugins in Python using the python plugin.
533 See collectd-python(5) for details.
536 Logs to the standard UNIX logging mechanism, syslog.
539 Writes log messages formatted as logstash JSON events.
541 * Notifications can be handled by the following plugins:
544 Send a desktop notification to a notification daemon, as defined in
545 the Desktop Notification Specification. To actually display the
546 notifications, notification-daemon is required.
547 See http://www.galago-project.org/specs/notification/.
550 Send an E-mail with the notification message to the configured
554 Submit notifications as passive check results to a local nagios instance.
557 Execute a program or script to handle the notification.
558 See collectd-exec(5).
561 Writes the notification message to a file or STDOUT/STDERR.
564 Send the notification to a remote host to handle it somehow.
567 Notifications are propagated to plugins written in Perl as well.
568 See collectd-perl(5).
571 It's possible to implement notification plugins in Python using the
572 python plugin. See collectd-python(5) for details.
574 * Value processing can be controlled using the "filter chain" infrastructure
575 and "matches" and "targets". The following plugins are available:
577 - match_empty_counter
578 Match counter values which are currently zero.
581 Match values using a hash function of the hostname.
584 Match values by their identifier based on regular expressions.
587 Match values with an invalid timestamp.
590 Select values by their data sources' values.
592 - target_notification
593 Create and dispatch a notification.
596 Replace parts of an identifier using regular expressions.
599 Scale (multiply) values by an arbitrary value.
602 Set (overwrite) entire parts of an identifier.
604 * Miscellaneous plugins:
607 Selects multiple value lists based on patterns or regular expressions
608 and creates new aggregated values lists from those.
611 Checks values against configured thresholds and creates notifications if
612 values are out of bounds. See collectd-threshold(5) for details.
615 Sets the hostname to a unique identifier. This is meant for setups
616 where each client may migrate to another physical host, possibly going
617 through one or more name changes in the process.
619 * Performance: Since collectd is running as a daemon it doesn't spend much
620 time starting up again and again. With the exception of the exec plugin no
621 processes are forked. Caching in output plugins, such as the rrdtool and
622 network plugins, makes sure your resources are used efficiently. Also,
623 since collectd is programmed multithreaded it benefits from hyper-threading
624 and multicore processors and makes sure that the daemon isn't idle if only
625 one plugin waits for an IO-operation to complete.
627 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
628 as possible and the default values should be okay for most users.
634 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
635 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
636 for a list of options and a syntax description.
638 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
639 files. The usual place for these files is beneath `/var/lib/collectd'.
641 * When using some of the plugins, collectd needs to run as user root, since
642 only root can do certain things, such as craft ICMP packages needed to ping
643 other hosts. collectd should NOT be installed setuid root since it can be
644 used to overwrite valuable files!
646 * Sample scripts to generate graphs reside in `contrib/' in the source
647 package or somewhere near `/usr/share/doc/collectd' in most distributions.
648 Please be aware that those script are meant as a starting point for your
649 own experiments.. Some of them require the `RRDs' Perl module.
650 (`librrds-perl' on Debian) If you have written a more sophisticated
651 solution please share it with us.
653 * The RRAs of the automatically created RRD files depend on the `step'
654 and `heartbeat' settings given. If change these settings you may need to
655 re-create the files, losing all data. Please be aware of that when changing
656 the values and read the rrdtool(1) manpage thoroughly.
659 collectd and chkrootkit
660 -----------------------
662 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
663 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
664 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
665 this case, collectd is a legitimate sniffer and the report should be
666 considered to be a false positive. However, you might want to check that
667 this really is collectd and not some other, illegitimate sniffer.
673 To compile collectd from source you will need:
675 * Usual suspects: C compiler, linker, preprocessor, make, ...
677 collectd makes use of some common C99 features, e.g. compound literals and
678 mixed declarations, and therefore requires a C99 compatible compiler.
680 On Debian and Ubuntu, the "build-essential" package should pull in
681 everything that's necessary.
683 * A POSIX-threads (pthread) implementation.
684 Since gathering some statistics is slow (network connections, slow devices,
685 etc) collectd is parallelized. The POSIX threads interface is being
686 used and should be found in various implementations for hopefully all
689 * When building from the Git repository, flex (tokenizer) and bison (parser
690 generator) are required. Release tarballs include the generated files – you
691 don't need these packages in that case.
693 * aerotools-ng (optional)
694 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
695 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
696 nor does it feature an installation routine. Therefore, you need to point
697 collectd's configure script at the source directory of the `aerotools-ng'
699 <https://github.com/lynix/aerotools-ng>
701 * CoreFoundation.framework and IOKit.framework (optional)
702 For compiling on Darwin in general and the `apple_sensors' plugin in
704 <http://developer.apple.com/corefoundation/>
706 * libatasmart (optional)
707 Used by the `smart' plugin.
708 <http://git.0pointer.de/?p=libatasmart.git>
711 The `turbostat' plugin can optionally build Linux Capabilities support,
712 which avoids full privileges requirement (aka. running as root) to read
714 <http://sites.google.com/site/fullycapable/>
716 * libclntsh (optional)
717 Used by the `oracle' plugin.
719 * libhiredis (optional)
720 Used by the redis plugin. Please note that you require a 0.10.0 version
721 or higher. <https://github.com/redis/hiredis>
724 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
725 `curl_xml', `nginx', or `write_http' plugin.
726 <http://curl.haxx.se/>
729 Used by the `dbi' plugin to connect to various databases.
730 <http://libdbi.sourceforge.net/>
732 * libesmtp (optional)
733 For the `notify_email' plugin.
734 <http://www.stafford.uklinux.net/libesmtp/>
736 * libganglia (optional)
737 Used by the `gmond' plugin to process data received from Ganglia.
738 <http://ganglia.info/>
741 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
745 * libgcrypt (optional)
746 Used by the `network' plugin for encryption and authentication.
747 <http://www.gnupg.org/>
750 Used by the `gps' plugin.
751 <http://developer.berlios.de/projects/gpsd/>
754 If present, the `uuid' plugin will check for UUID from HAL.
755 <http://hal.freedesktop.org/>
757 * libi2c-dev (optional)
758 Used for the plugin `barometer', provides just the i2c-dev.h header file
759 for user space i2c development.
762 For querying iptables counters.
763 <http://netfilter.org/>
766 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
767 used by the `java' plugin to execute Java bytecode.
768 See docs/BUILD.java.md for detailed build instructions.
769 <http://openjdk.java.net/> (and others)
772 Used by the `openldap' plugin.
773 <http://www.openldap.org/>
776 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
777 <https://www.lua.org/>
780 Used by the `lvm' plugin.
781 <ftp://sources.redhat.com/pub/lvm2/>
783 * libmemcached (optional)
784 Used by the `memcachec' plugin to connect to a memcache daemon.
785 <http://tangent.org/552/libmemcached.html>
787 * libmicrohttpd (optional)
788 Used by the write_prometheus plugin to run an http daemon.
789 <http://www.gnu.org/software/libmicrohttpd/>
792 Used by the `netlink' plugin.
793 <http://www.netfilter.org/projects/libmnl/>
795 * libmodbus (optional)
796 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
797 `modbus' plugin works with version 2.0.3 of the library – due to frequent
798 API changes other versions may or may not compile cleanly.
799 <http://www.libmodbus.org/>
801 * libmysqlclient (optional)
802 Unsurprisingly used by the `mysql' plugin.
803 <http://dev.mysql.com/>
805 * libnetapp (optional)
806 Required for the `netapp' plugin.
807 This library is part of the “Manage ONTAP SDK” published by NetApp.
809 * libnetsnmp (optional)
810 For the `snmp' plugin.
811 <http://www.net-snmp.org/>
813 * libnotify (optional)
814 For the `notify_desktop' plugin.
815 <http://www.galago-project.org/>
817 * libopenipmi (optional)
818 Used by the `ipmi' plugin to prove IPMI devices.
819 <http://openipmi.sourceforge.net/>
821 * liboping (optional)
822 Used by the `ping' plugin to send and receive ICMP packets.
823 <http://octo.it/liboping/>
825 * libowcapi (optional)
826 Used by the `onewire' plugin to read values from onewire sensors (or the
828 <http://www.owfs.org/>
831 Used to capture packets by the `dns' plugin.
832 <http://www.tcpdump.org/>
834 * libperfstat (optional)
835 Used by various plugins to gather statistics under AIX.
838 Obviously used by the `perl' plugin. The library has to be compiled with
839 ithread support (introduced in Perl 5.6.0).
840 <http://www.perl.org/>
843 The PostgreSQL C client library used by the `postgresql' plugin.
844 <http://www.postgresql.org/>
847 The PQoS library for Intel(R) Resource Director Technology used by the
849 <https://github.com/01org/intel-cmt-cat>
851 * libprotobuf, protoc 3.0+ (optional)
852 Used by the `grpc' plugin to generate service stubs and code to handle
853 network packets of collectd's protobuf-based network protocol.
854 <https://developers.google.com/protocol-buffers/>
856 * libprotobuf-c, protoc-c (optional)
857 Used by the `pinba' plugin to generate a parser for the network packets
858 sent by the Pinba PHP extension.
859 <http://code.google.com/p/protobuf-c/>
861 * libpython (optional)
862 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
864 <http://www.python.org/>
866 * librabbitmq (optional; also called “rabbitmq-c”)
867 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
868 <http://hg.rabbitmq.com/rabbitmq-c/>
870 * librdkafka (optional; also called “rdkafka”)
871 Used by the `write_kafka' plugin for producing messages and sending them
873 <https://github.com/edenhill/librdkafka>
875 * librouteros (optional)
876 Used by the `routeros' plugin to connect to a device running `RouterOS'.
877 <http://octo.it/librouteros/>
880 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
881 client support which was added after version 1.3 of RRDtool. Versions 1.0,
882 1.2 and 1.3 are known to work with the `rrdtool' plugin.
883 <http://oss.oetiker.ch/rrdtool/>
885 * librt, libsocket, libkstat, libdevinfo (optional)
886 Various standard Solaris libraries which provide system functions.
887 <http://developers.sun.com/solaris/>
889 * libsensors (optional)
890 To read from `lm_sensors', see the `sensors' plugin.
891 <http://www.lm-sensors.org/>
893 * libsigrok (optional)
894 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
895 libzip, and optionally (depending on which drivers are enabled) on
896 libusb, libftdi and libudev.
898 * libstatgrab (optional)
899 Used by various plugins to collect statistics on systems other than Linux
901 <http://www.i-scream.org/libstatgrab/>
903 * libtokyotyrant (optional)
904 Used by the `tokyotyrant' plugin.
905 <http://1978th.net/tokyotyrant/>
907 * libupsclient/nut (optional)
908 For the `nut' plugin which queries nut's `upsd'.
909 <http://networkupstools.org/>
912 Collect statistics from virtual machines.
913 <http://libvirt.org/>
916 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
918 <http://xmlsoft.org/>
921 Used by the `xencpu' plugin.
922 <http://xenbits.xensource.com/>
925 <http://www.xmms.org/>
928 Parse JSON data. This is needed for the `ceph', `curl_json' and
929 `log_logstash' plugins.
930 <http://github.com/lloyd/yajl>
932 * libvarnish (optional)
933 Fetches statistics from a Varnish instance. This is needed for the
935 <http://varnish-cache.org>
937 * riemann-c-client (optional)
938 For the `write_riemann' plugin.
939 <https://github.com/algernon/riemann-c-client>
941 Configuring / Compiling / Installing
942 ------------------------------------
944 To configure, build and install collectd with the default settings, run
945 `./configure && make && make install'. For detailed, generic instructions
946 see INSTALL. For a complete list of configure options and their description,
947 run `./configure --help'.
949 By default, the configure script will check for all build dependencies and
950 disable all plugins whose requirements cannot be fulfilled (any other plugin
951 will be enabled). To enable a plugin, install missing dependencies (see
952 section `Prerequisites' above) and rerun `configure'. If you specify the
953 `--enable-<plugin>' configure option, the script will fail if the depen-
954 dencies for the specified plugin are not met. In that case you can force the
955 plugin to be built using the `--enable-<plugin>=force' configure option.
956 This will most likely fail though unless you're working in a very unusual
957 setup and you really know what you're doing. If you specify the
958 `--disable-<plugin>' configure option, the plugin will not be built. If you
959 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
960 options, all plugins will be enabled or disabled respectively by default.
961 Explicitly enabling or disabling a plugin overwrites the default for the
962 specified plugin. These options are meant for package maintainers and should
963 not be used in everyday situations.
965 By default, collectd will be installed into `/opt/collectd'. You can adjust
966 this setting by specifying the `--prefix' configure option - see INSTALL for
967 details. If you pass DESTDIR=<path> to `make install', <path> will be
968 prefixed to all installation directories. This might be useful when creating
969 packages for collectd.
971 Generating the configure script
972 -------------------------------
974 Collectd ships with a `build.sh' script to generate the `configure'
975 script shipped with releases.
977 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