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 plugin monitors the link status of OVS connected interfaces and
293 dispatches the values through collectd notification mechanism. It
294 requires YAJL library to be installed.
295 Detailed instructions for installing and setting up Open vSwitch, see
297 <http://openvswitch.org/support/dist-docs/INSTALL.md.html>
300 The perl plugin implements a Perl-interpreter into collectd. You can
301 write your own plugins in Perl and return arbitrary values using this
302 API. See collectd-perl(5).
305 Query statistics from BSD's packet filter "pf".
308 Receive and dispatch timing values from Pinba, a profiling extension for
312 Network latency: Time to reach the default gateway or another given
316 PostgreSQL database statistics: active server connections, transaction
317 numbers, block IO, table row manipulations.
320 PowerDNS name server statistics.
323 Process counts: Number of running, sleeping, zombie, ... processes.
326 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
329 The python plugin implements a Python interpreter into collectd. This
330 makes it possible to write plugins in Python which are executed by
331 collectd without the need to start a heavy interpreter every interval.
332 See collectd-python(5) for details.
335 The redis plugin gathers information from a Redis server, including:
336 uptime, used memory, total connections etc.
339 Query interface and wireless registration statistics from RouterOS.
342 RRDtool caching daemon (RRDcacheD) statistics.
345 System sensors, accessed using lm_sensors: Voltages, temperatures and
349 RX and TX of serial interfaces. Linux only; needs root privileges.
352 Uses libsigrok as a backend, allowing any sigrok-supported device
353 to have its measurements fed to collectd. This includes multimeters,
354 sound level meters, thermometers, and much more.
357 Collect SMART statistics, notably load cycle count, temperature
361 Read values from SNMP (Simple Network Management Protocol) enabled
362 network devices such as switches, routers, thermometers, rack monitoring
363 servers, etc. See collectd-snmp(5).
366 Acts as a StatsD server, reading values sent over the network from StatsD
367 clients and calculating rates and other aggregates out of these values.
370 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
373 Parse table-like structured files.
376 Follows (tails) log files, parses them by lines and submits matched
380 Follows (tails) files in CSV format, parses each line and submits
384 Bytes and operations read and written on tape devices. Solaris only.
387 Number of TCP connections to specific local and remote ports.
390 TeamSpeak2 server statistics.
393 Plugin to read values from `The Energy Detective' (TED).
396 Linux ACPI thermal zone information.
399 Reads the number of records and file size from a running Tokyo Tyrant
403 Reads CPU frequency and C-state residency on modern Intel
404 turbo-capable processors.
407 System uptime statistics.
410 Users currently logged in.
413 Various statistics from Varnish, an HTTP accelerator.
416 CPU, memory, disk and network I/O statistics from virtual machines.
419 Virtual memory statistics, e.g. the number of page-ins/-outs or the
420 number of pagefaults.
423 System resources used by Linux VServers.
424 See <http://linux-vserver.org/>.
427 Link quality of wireless cards. Linux only.
430 XEN Hypervisor CPU stats.
433 Bitrate and frequency of music played with XMMS.
436 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
439 Measures the percentage of cpu load per container (zone) under Solaris 10
443 Read data from Zookeeper's MNTR command.
445 * Output can be written or sent to various destinations by the following
449 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
450 server, such as RabbitMQ.
453 Write to comma separated values (CSV) files. This needs lots of
454 diskspace but is extremely portable and can be analysed with almost
455 every program that can analyse anything. Even Microsoft's Excel..
458 Send and receive values over the network using the gRPC framework.
461 It's possible to implement write plugins in Lua using the Lua
462 plugin. See collectd-lua(5) for details.
465 Publishes and subscribes to MQTT topics.
468 Send the data to a remote host to save the data somehow. This is useful
469 for large setups where the data should be saved by a dedicated machine.
472 Of course the values are propagated to plugins written in Perl, too, so
473 you can easily do weird stuff with the plugins we didn't dare think of
474 ;) See collectd-perl(5).
477 It's possible to implement write plugins in Python using the python
478 plugin. See collectd-python(5) for details.
481 Output to round-robin-database (RRD) files using the RRDtool caching
482 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
483 implementation of the caching done by the `rrdtool' plugin.
486 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
487 This is likely the most popular destination for such values. Since
488 updates to RRD-files are somewhat expensive this plugin can cache
489 updates to the files and write a bunch of updates at once, which lessens
493 One can query the values from the unixsock plugin whenever they're
494 needed. Please read collectd-unixsock(5) for a description on how that's
498 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
499 can be configured to avoid logging send errors (especially useful when
503 Sends the values collected by collectd to a web-server using HTTP POST
504 requests. The transmitted data is either in a form understood by the
505 Exec plugin or formatted in JSON.
508 Sends data to Apache Kafka, a distributed queue.
511 Writes data to the log
514 Sends data to MongoDB, a NoSQL database.
517 Publish values using an embedded HTTP server, in a format compatible
518 with Prometheus' collectd_exporter.
521 Sends the values to a Redis key-value database server.
524 Sends data to Riemann, a stream processing and monitoring system.
527 Sends data to Sensu, a stream processing and monitoring system, via the
528 Sensu client local TCP socket.
531 Sends data OpenTSDB, a scalable no master, no shared state time series
534 * Logging is, as everything in collectd, provided by plugins. The following
535 plugins keep us informed about what's going on:
538 Writes log messages to a file or STDOUT/STDERR.
541 Log messages are propagated to plugins written in Perl as well.
542 See collectd-perl(5).
545 It's possible to implement log plugins in Python using the python plugin.
546 See collectd-python(5) for details.
549 Logs to the standard UNIX logging mechanism, syslog.
552 Writes log messages formatted as logstash JSON events.
554 * Notifications can be handled by the following plugins:
557 Send a desktop notification to a notification daemon, as defined in
558 the Desktop Notification Specification. To actually display the
559 notifications, notification-daemon is required.
560 See http://www.galago-project.org/specs/notification/.
563 Send an E-mail with the notification message to the configured
567 Submit notifications as passive check results to a local nagios instance.
570 Execute a program or script to handle the notification.
571 See collectd-exec(5).
574 Writes the notification message to a file or STDOUT/STDERR.
577 Send the notification to a remote host to handle it somehow.
580 Notifications are propagated to plugins written in Perl as well.
581 See collectd-perl(5).
584 It's possible to implement notification plugins in Python using the
585 python plugin. See collectd-python(5) for details.
587 * Value processing can be controlled using the "filter chain" infrastructure
588 and "matches" and "targets". The following plugins are available:
590 - match_empty_counter
591 Match counter values which are currently zero.
594 Match values using a hash function of the hostname.
597 Match values by their identifier based on regular expressions.
600 Match values with an invalid timestamp.
603 Select values by their data sources' values.
605 - target_notification
606 Create and dispatch a notification.
609 Replace parts of an identifier using regular expressions.
612 Scale (multiply) values by an arbitrary value.
615 Set (overwrite) entire parts of an identifier.
617 * Miscellaneous plugins:
620 Selects multiple value lists based on patterns or regular expressions
621 and creates new aggregated values lists from those.
624 Checks values against configured thresholds and creates notifications if
625 values are out of bounds. See collectd-threshold(5) for details.
628 Sets the hostname to a unique identifier. This is meant for setups
629 where each client may migrate to another physical host, possibly going
630 through one or more name changes in the process.
632 * Performance: Since collectd is running as a daemon it doesn't spend much
633 time starting up again and again. With the exception of the exec plugin no
634 processes are forked. Caching in output plugins, such as the rrdtool and
635 network plugins, makes sure your resources are used efficiently. Also,
636 since collectd is programmed multithreaded it benefits from hyper-threading
637 and multicore processors and makes sure that the daemon isn't idle if only
638 one plugin waits for an IO-operation to complete.
640 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
641 as possible and the default values should be okay for most users.
647 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
648 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
649 for a list of options and a syntax description.
651 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
652 files. The usual place for these files is beneath `/var/lib/collectd'.
654 * When using some of the plugins, collectd needs to run as user root, since
655 only root can do certain things, such as craft ICMP packages needed to ping
656 other hosts. collectd should NOT be installed setuid root since it can be
657 used to overwrite valuable files!
659 * Sample scripts to generate graphs reside in `contrib/' in the source
660 package or somewhere near `/usr/share/doc/collectd' in most distributions.
661 Please be aware that those script are meant as a starting point for your
662 own experiments.. Some of them require the `RRDs' Perl module.
663 (`librrds-perl' on Debian) If you have written a more sophisticated
664 solution please share it with us.
666 * The RRAs of the automatically created RRD files depend on the `step'
667 and `heartbeat' settings given. If change these settings you may need to
668 re-create the files, losing all data. Please be aware of that when changing
669 the values and read the rrdtool(1) manpage thoroughly.
672 collectd and chkrootkit
673 -----------------------
675 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
676 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
677 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
678 this case, collectd is a legitimate sniffer and the report should be
679 considered to be a false positive. However, you might want to check that
680 this really is collectd and not some other, illegitimate sniffer.
686 To compile collectd from source you will need:
688 * Usual suspects: C compiler, linker, preprocessor, make, ...
690 collectd makes use of some common C99 features, e.g. compound literals and
691 mixed declarations, and therefore requires a C99 compatible compiler.
693 On Debian and Ubuntu, the "build-essential" package should pull in
694 everything that's necessary.
696 * A POSIX-threads (pthread) implementation.
697 Since gathering some statistics is slow (network connections, slow devices,
698 etc) collectd is parallelized. The POSIX threads interface is being
699 used and should be found in various implementations for hopefully all
702 * When building from the Git repository, flex (tokenizer) and bison (parser
703 generator) are required. Release tarballs include the generated files – you
704 don't need these packages in that case.
706 * aerotools-ng (optional)
707 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
708 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
709 nor does it feature an installation routine. Therefore, you need to point
710 collectd's configure script at the source directory of the `aerotools-ng'
712 <https://github.com/lynix/aerotools-ng>
714 * CoreFoundation.framework and IOKit.framework (optional)
715 For compiling on Darwin in general and the `apple_sensors' plugin in
717 <http://developer.apple.com/corefoundation/>
719 * libatasmart (optional)
720 Used by the `smart' plugin.
721 <http://git.0pointer.de/?p=libatasmart.git>
724 The `turbostat' plugin can optionally build Linux Capabilities support,
725 which avoids full privileges requirement (aka. running as root) to read
727 <http://sites.google.com/site/fullycapable/>
729 * libclntsh (optional)
730 Used by the `oracle' plugin.
732 * libhiredis (optional)
733 Used by the redis plugin. Please note that you require a 0.10.0 version
734 or higher. <https://github.com/redis/hiredis>
737 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
738 `curl_xml', `nginx', or `write_http' plugin.
739 <http://curl.haxx.se/>
742 Used by the `dbi' plugin to connect to various databases.
743 <http://libdbi.sourceforge.net/>
745 * libesmtp (optional)
746 For the `notify_email' plugin.
747 <http://www.stafford.uklinux.net/libesmtp/>
749 * libganglia (optional)
750 Used by the `gmond' plugin to process data received from Ganglia.
751 <http://ganglia.info/>
754 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
758 * libgcrypt (optional)
759 Used by the `network' plugin for encryption and authentication.
760 <http://www.gnupg.org/>
763 Used by the `gps' plugin.
764 <http://developer.berlios.de/projects/gpsd/>
766 * libi2c-dev (optional)
767 Used for the plugin `barometer', provides just the i2c-dev.h header file
768 for user space i2c development.
771 For querying iptables counters.
772 <http://netfilter.org/>
775 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
776 used by the `java' plugin to execute Java bytecode.
777 See docs/BUILD.java.md for detailed build instructions.
778 <http://openjdk.java.net/> (and others)
781 Used by the `openldap' plugin.
782 <http://www.openldap.org/>
785 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
786 <https://www.lua.org/>
789 Used by the `lvm' plugin.
790 <ftp://sources.redhat.com/pub/lvm2/>
792 * libmemcached (optional)
793 Used by the `memcachec' plugin to connect to a memcache daemon.
794 <http://tangent.org/552/libmemcached.html>
796 * libmicrohttpd (optional)
797 Used by the write_prometheus plugin to run an http daemon.
798 <http://www.gnu.org/software/libmicrohttpd/>
801 Used by the `netlink' plugin.
802 <http://www.netfilter.org/projects/libmnl/>
804 * libmodbus (optional)
805 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
806 `modbus' plugin works with version 2.0.3 of the library – due to frequent
807 API changes other versions may or may not compile cleanly.
808 <http://www.libmodbus.org/>
810 * libmysqlclient (optional)
811 Unsurprisingly used by the `mysql' plugin.
812 <http://dev.mysql.com/>
814 * libnetapp (optional)
815 Required for the `netapp' plugin.
816 This library is part of the “Manage ONTAP SDK” published by NetApp.
818 * libnetsnmp (optional)
819 For the `snmp' plugin.
820 <http://www.net-snmp.org/>
822 * libnotify (optional)
823 For the `notify_desktop' plugin.
824 <http://www.galago-project.org/>
826 * libopenipmi (optional)
827 Used by the `ipmi' plugin to prove IPMI devices.
828 <http://openipmi.sourceforge.net/>
830 * liboping (optional)
831 Used by the `ping' plugin to send and receive ICMP packets.
832 <http://octo.it/liboping/>
834 * libowcapi (optional)
835 Used by the `onewire' plugin to read values from onewire sensors (or the
837 <http://www.owfs.org/>
840 Used to capture packets by the `dns' plugin.
841 <http://www.tcpdump.org/>
843 * libperfstat (optional)
844 Used by various plugins to gather statistics under AIX.
847 Obviously used by the `perl' plugin. The library has to be compiled with
848 ithread support (introduced in Perl 5.6.0).
849 <http://www.perl.org/>
852 The PostgreSQL C client library used by the `postgresql' plugin.
853 <http://www.postgresql.org/>
856 The PQoS library for Intel(R) Resource Director Technology used by the
858 <https://github.com/01org/intel-cmt-cat>
860 * libprotobuf, protoc 3.0+ (optional)
861 Used by the `grpc' plugin to generate service stubs and code to handle
862 network packets of collectd's protobuf-based network protocol.
863 <https://developers.google.com/protocol-buffers/>
865 * libprotobuf-c, protoc-c (optional)
866 Used by the `pinba' plugin to generate a parser for the network packets
867 sent by the Pinba PHP extension.
868 <http://code.google.com/p/protobuf-c/>
870 * libpython (optional)
871 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
873 <http://www.python.org/>
875 * librabbitmq (optional; also called “rabbitmq-c”)
876 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
877 <http://hg.rabbitmq.com/rabbitmq-c/>
879 * librdkafka (optional; also called “rdkafka”)
880 Used by the `write_kafka' plugin for producing messages and sending them
882 <https://github.com/edenhill/librdkafka>
884 * librouteros (optional)
885 Used by the `routeros' plugin to connect to a device running `RouterOS'.
886 <http://octo.it/librouteros/>
889 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
890 client support which was added after version 1.3 of RRDtool. Versions 1.0,
891 1.2 and 1.3 are known to work with the `rrdtool' plugin.
892 <http://oss.oetiker.ch/rrdtool/>
894 * librt, libsocket, libkstat, libdevinfo (optional)
895 Various standard Solaris libraries which provide system functions.
896 <http://developers.sun.com/solaris/>
898 * libsensors (optional)
899 To read from `lm_sensors', see the `sensors' plugin.
900 <http://www.lm-sensors.org/>
902 * libsigrok (optional)
903 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
904 libzip, and optionally (depending on which drivers are enabled) on
905 libusb, libftdi and libudev.
907 * libstatgrab (optional)
908 Used by various plugins to collect statistics on systems other than Linux
910 <http://www.i-scream.org/libstatgrab/>
912 * libtokyotyrant (optional)
913 Used by the `tokyotyrant' plugin.
914 <http://1978th.net/tokyotyrant/>
916 * libupsclient/nut (optional)
917 For the `nut' plugin which queries nut's `upsd'.
918 <http://networkupstools.org/>
921 Collect statistics from virtual machines.
922 <http://libvirt.org/>
925 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
927 <http://xmlsoft.org/>
930 Used by the `xencpu' plugin.
931 <http://xenbits.xensource.com/>
934 <http://www.xmms.org/>
937 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_link' and
938 `log_logstash' plugins.
939 <http://github.com/lloyd/yajl>
941 * libvarnish (optional)
942 Fetches statistics from a Varnish instance. This is needed for the
944 <http://varnish-cache.org>
946 * riemann-c-client (optional)
947 For the `write_riemann' plugin.
948 <https://github.com/algernon/riemann-c-client>
950 Configuring / Compiling / Installing
951 ------------------------------------
953 To configure, build and install collectd with the default settings, run
954 `./configure && make && make install'. For detailed, generic instructions
955 see INSTALL. For a complete list of configure options and their description,
956 run `./configure --help'.
958 By default, the configure script will check for all build dependencies and
959 disable all plugins whose requirements cannot be fulfilled (any other plugin
960 will be enabled). To enable a plugin, install missing dependencies (see
961 section `Prerequisites' above) and rerun `configure'. If you specify the
962 `--enable-<plugin>' configure option, the script will fail if the depen-
963 dencies for the specified plugin are not met. In that case you can force the
964 plugin to be built using the `--enable-<plugin>=force' configure option.
965 This will most likely fail though unless you're working in a very unusual
966 setup and you really know what you're doing. If you specify the
967 `--disable-<plugin>' configure option, the plugin will not be built. If you
968 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
969 options, all plugins will be enabled or disabled respectively by default.
970 Explicitly enabling or disabling a plugin overwrites the default for the
971 specified plugin. These options are meant for package maintainers and should
972 not be used in everyday situations.
974 By default, collectd will be installed into `/opt/collectd'. You can adjust
975 this setting by specifying the `--prefix' configure option - see INSTALL for
976 details. If you pass DESTDIR=<path> to `make install', <path> will be
977 prefixed to all installation directories. This might be useful when creating
978 packages for collectd.
980 Generating the configure script
981 -------------------------------
983 Collectd ships with a `build.sh' script to generate the `configure'
984 script shipped with releases.
986 To generate the `configure` script, you'll need the following dependencies:
995 The `build.sh' script takes no arguments.
1001 To compile correctly collectd needs to be able to initialize static
1002 variables to NAN (Not A Number). Some C libraries, especially the GNU
1003 libc, have a problem with that.
1005 Luckily, with GCC it's possible to work around that problem: One can define
1006 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1007 ``implementation'' the configure script needs to compile and run a short
1008 test program. Obviously running a test program when doing a cross-
1009 compilation is, well, challenging.
1011 If you run into this problem, you can use the `--with-nan-emulation'
1012 configure option to force the use of this implementation. We can't promise
1013 that the compiled binary actually behaves as it should, but since NANs
1014 are likely never passed to the libm you have a good chance to be lucky.
1016 Likewise, collectd needs to know the layout of doubles in memory, in order
1017 to craft uniform network packets over different architectures. For this, it
1018 needs to know how to convert doubles into the memory layout used by x86. The
1019 configure script tries to figure this out by compiling and running a few
1020 small test programs. This is of course not possible when cross-compiling.
1021 You can use the `--with-fp-layout' option to tell the configure script which
1022 conversion method to assume. Valid arguments are:
1024 * `nothing' (12345678 -> 12345678)
1025 * `endianflip' (12345678 -> 87654321)
1026 * `intswap' (12345678 -> 56781234)
1032 Please use GitHub to report bugs and submit pull requests:
1033 <https://github.com/collectd/collectd/>.
1034 See CONTRIBUTING.md for details.
1036 For questions, development information and basically all other concerns please
1037 send an email to collectd's mailing list at
1038 <list at collectd.org>.
1040 For live discussion and more personal contact visit us in IRC, we're in
1041 channel #collectd on freenode.
1047 Florian octo Forster <octo at collectd.org>,
1048 Sebastian tokkee Harl <sh at tokkee.org>,
1049 and many contributors (see `AUTHORS').
projects / collectd.git / blob