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 Open vSwitch (OVS) connected
293 interfaces, dispatches the values to collectd and sends the notification
294 whenever the link state change occurs in the OVS database. It requires
295 YAJL library to be installed.
296 Detailed instructions for installing and setting up Open vSwitch, see
298 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
301 The perl plugin implements a Perl-interpreter into collectd. You can
302 write your own plugins in Perl and return arbitrary values using this
303 API. See collectd-perl(5).
306 Query statistics from BSD's packet filter "pf".
309 Receive and dispatch timing values from Pinba, a profiling extension for
313 Network latency: Time to reach the default gateway or another given
317 PostgreSQL database statistics: active server connections, transaction
318 numbers, block IO, table row manipulations.
321 PowerDNS name server statistics.
324 Process counts: Number of running, sleeping, zombie, ... processes.
327 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
330 The python plugin implements a Python interpreter into collectd. This
331 makes it possible to write plugins in Python which are executed by
332 collectd without the need to start a heavy interpreter every interval.
333 See collectd-python(5) for details.
336 The redis plugin gathers information from a Redis server, including:
337 uptime, used memory, total connections etc.
340 Query interface and wireless registration statistics from RouterOS.
343 RRDtool caching daemon (RRDcacheD) statistics.
346 System sensors, accessed using lm_sensors: Voltages, temperatures and
350 RX and TX of serial interfaces. Linux only; needs root privileges.
353 Uses libsigrok as a backend, allowing any sigrok-supported device
354 to have its measurements fed to collectd. This includes multimeters,
355 sound level meters, thermometers, and much more.
358 Collect SMART statistics, notably load cycle count, temperature
362 Read values from SNMP (Simple Network Management Protocol) enabled
363 network devices such as switches, routers, thermometers, rack monitoring
364 servers, etc. See collectd-snmp(5).
367 Acts as a StatsD server, reading values sent over the network from StatsD
368 clients and calculating rates and other aggregates out of these values.
371 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
374 Parse table-like structured files.
377 Follows (tails) log files, parses them by lines and submits matched
381 Follows (tails) files in CSV format, parses each line and submits
385 Bytes and operations read and written on tape devices. Solaris only.
388 Number of TCP connections to specific local and remote ports.
391 TeamSpeak2 server statistics.
394 Plugin to read values from `The Energy Detective' (TED).
397 Linux ACPI thermal zone information.
400 Reads the number of records and file size from a running Tokyo Tyrant
404 Reads CPU frequency and C-state residency on modern Intel
405 turbo-capable processors.
408 System uptime statistics.
411 Users currently logged in.
414 Various statistics from Varnish, an HTTP accelerator.
417 CPU, memory, disk and network I/O statistics from virtual machines.
420 Virtual memory statistics, e.g. the number of page-ins/-outs or the
421 number of pagefaults.
424 System resources used by Linux VServers.
425 See <http://linux-vserver.org/>.
428 Link quality of wireless cards. Linux only.
431 XEN Hypervisor CPU stats.
434 Bitrate and frequency of music played with XMMS.
437 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
440 Measures the percentage of cpu load per container (zone) under Solaris 10
444 Read data from Zookeeper's MNTR command.
446 * Output can be written or sent to various destinations by the following
450 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
451 server, such as RabbitMQ.
454 Write to comma separated values (CSV) files. This needs lots of
455 diskspace but is extremely portable and can be analysed with almost
456 every program that can analyse anything. Even Microsoft's Excel..
459 Send and receive values over the network using the gRPC framework.
462 It's possible to implement write plugins in Lua using the Lua
463 plugin. See collectd-lua(5) for details.
466 Publishes and subscribes to MQTT topics.
469 Send the data to a remote host to save the data somehow. This is useful
470 for large setups where the data should be saved by a dedicated machine.
473 Of course the values are propagated to plugins written in Perl, too, so
474 you can easily do weird stuff with the plugins we didn't dare think of
475 ;) See collectd-perl(5).
478 It's possible to implement write plugins in Python using the python
479 plugin. See collectd-python(5) for details.
482 Output to round-robin-database (RRD) files using the RRDtool caching
483 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
484 implementation of the caching done by the `rrdtool' plugin.
487 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
488 This is likely the most popular destination for such values. Since
489 updates to RRD-files are somewhat expensive this plugin can cache
490 updates to the files and write a bunch of updates at once, which lessens
494 Receives and handles queries from SNMP master agent and returns the data
495 collected by read plugins. Handles requests only for OIDs specified in
496 configuration file. To handle SNMP queries the plugin gets data from
497 collectd and translates requested values from collectd's internal format
501 One can query the values from the unixsock plugin whenever they're
502 needed. Please read collectd-unixsock(5) for a description on how that's
506 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
507 can be configured to avoid logging send errors (especially useful when
511 Sends the values collected by collectd to a web-server using HTTP POST
512 requests. The transmitted data is either in a form understood by the
513 Exec plugin or formatted in JSON.
516 Sends data to Apache Kafka, a distributed queue.
519 Writes data to the log
522 Sends data to MongoDB, a NoSQL database.
525 Publish values using an embedded HTTP server, in a format compatible
526 with Prometheus' collectd_exporter.
529 Sends the values to a Redis key-value database server.
532 Sends data to Riemann, a stream processing and monitoring system.
535 Sends data to Sensu, a stream processing and monitoring system, via the
536 Sensu client local TCP socket.
539 Sends data OpenTSDB, a scalable no master, no shared state time series
542 * Logging is, as everything in collectd, provided by plugins. The following
543 plugins keep us informed about what's going on:
546 Writes log messages to a file or STDOUT/STDERR.
549 Log messages are propagated to plugins written in Perl as well.
550 See collectd-perl(5).
553 It's possible to implement log plugins in Python using the python plugin.
554 See collectd-python(5) for details.
557 Logs to the standard UNIX logging mechanism, syslog.
560 Writes log messages formatted as logstash JSON events.
562 * Notifications can be handled by the following plugins:
565 Send a desktop notification to a notification daemon, as defined in
566 the Desktop Notification Specification. To actually display the
567 notifications, notification-daemon is required.
568 See http://www.galago-project.org/specs/notification/.
571 Send an E-mail with the notification message to the configured
575 Submit notifications as passive check results to a local nagios instance.
578 Execute a program or script to handle the notification.
579 See collectd-exec(5).
582 Writes the notification message to a file or STDOUT/STDERR.
585 Send the notification to a remote host to handle it somehow.
588 Notifications are propagated to plugins written in Perl as well.
589 See collectd-perl(5).
592 It's possible to implement notification plugins in Python using the
593 python plugin. See collectd-python(5) for details.
595 * Value processing can be controlled using the "filter chain" infrastructure
596 and "matches" and "targets". The following plugins are available:
598 - match_empty_counter
599 Match counter values which are currently zero.
602 Match values using a hash function of the hostname.
605 Match values by their identifier based on regular expressions.
608 Match values with an invalid timestamp.
611 Select values by their data sources' values.
613 - target_notification
614 Create and dispatch a notification.
617 Replace parts of an identifier using regular expressions.
620 Scale (multiply) values by an arbitrary value.
623 Set (overwrite) entire parts of an identifier.
625 * Miscellaneous plugins:
628 Selects multiple value lists based on patterns or regular expressions
629 and creates new aggregated values lists from those.
632 Checks values against configured thresholds and creates notifications if
633 values are out of bounds. See collectd-threshold(5) for details.
636 Sets the hostname to a unique identifier. This is meant for setups
637 where each client may migrate to another physical host, possibly going
638 through one or more name changes in the process.
640 * Performance: Since collectd is running as a daemon it doesn't spend much
641 time starting up again and again. With the exception of the exec plugin no
642 processes are forked. Caching in output plugins, such as the rrdtool and
643 network plugins, makes sure your resources are used efficiently. Also,
644 since collectd is programmed multithreaded it benefits from hyper-threading
645 and multicore processors and makes sure that the daemon isn't idle if only
646 one plugin waits for an IO-operation to complete.
648 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
649 as possible and the default values should be okay for most users.
655 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
656 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
657 for a list of options and a syntax description.
659 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
660 files. The usual place for these files is beneath `/var/lib/collectd'.
662 * When using some of the plugins, collectd needs to run as user root, since
663 only root can do certain things, such as craft ICMP packages needed to ping
664 other hosts. collectd should NOT be installed setuid root since it can be
665 used to overwrite valuable files!
667 * Sample scripts to generate graphs reside in `contrib/' in the source
668 package or somewhere near `/usr/share/doc/collectd' in most distributions.
669 Please be aware that those script are meant as a starting point for your
670 own experiments.. Some of them require the `RRDs' Perl module.
671 (`librrds-perl' on Debian) If you have written a more sophisticated
672 solution please share it with us.
674 * The RRAs of the automatically created RRD files depend on the `step'
675 and `heartbeat' settings given. If change these settings you may need to
676 re-create the files, losing all data. Please be aware of that when changing
677 the values and read the rrdtool(1) manpage thoroughly.
680 collectd and chkrootkit
681 -----------------------
683 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
684 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
685 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
686 this case, collectd is a legitimate sniffer and the report should be
687 considered to be a false positive. However, you might want to check that
688 this really is collectd and not some other, illegitimate sniffer.
694 To compile collectd from source you will need:
696 * Usual suspects: C compiler, linker, preprocessor, make, ...
698 collectd makes use of some common C99 features, e.g. compound literals and
699 mixed declarations, and therefore requires a C99 compatible compiler.
701 On Debian and Ubuntu, the "build-essential" package should pull in
702 everything that's necessary.
704 * A POSIX-threads (pthread) implementation.
705 Since gathering some statistics is slow (network connections, slow devices,
706 etc) collectd is parallelized. The POSIX threads interface is being
707 used and should be found in various implementations for hopefully all
710 * When building from the Git repository, flex (tokenizer) and bison (parser
711 generator) are required. Release tarballs include the generated files – you
712 don't need these packages in that case.
714 * aerotools-ng (optional)
715 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
716 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
717 nor does it feature an installation routine. Therefore, you need to point
718 collectd's configure script at the source directory of the `aerotools-ng'
720 <https://github.com/lynix/aerotools-ng>
722 * CoreFoundation.framework and IOKit.framework (optional)
723 For compiling on Darwin in general and the `apple_sensors' plugin in
725 <http://developer.apple.com/corefoundation/>
727 * libatasmart (optional)
728 Used by the `smart' plugin.
729 <http://git.0pointer.de/?p=libatasmart.git>
732 The `turbostat' plugin can optionally build Linux Capabilities support,
733 which avoids full privileges requirement (aka. running as root) to read
735 <http://sites.google.com/site/fullycapable/>
737 * libclntsh (optional)
738 Used by the `oracle' plugin.
740 * libhiredis (optional)
741 Used by the redis plugin. Please note that you require a 0.10.0 version
742 or higher. <https://github.com/redis/hiredis>
745 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
746 `curl_xml', `nginx', or `write_http' plugin.
747 <http://curl.haxx.se/>
750 Used by the `dbi' plugin to connect to various databases.
751 <http://libdbi.sourceforge.net/>
753 * libesmtp (optional)
754 For the `notify_email' plugin.
755 <http://www.stafford.uklinux.net/libesmtp/>
757 * libganglia (optional)
758 Used by the `gmond' plugin to process data received from Ganglia.
759 <http://ganglia.info/>
762 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
766 * libgcrypt (optional)
767 Used by the `network' plugin for encryption and authentication.
768 <http://www.gnupg.org/>
771 Used by the `gps' plugin.
772 <http://developer.berlios.de/projects/gpsd/>
774 * libi2c-dev (optional)
775 Used for the plugin `barometer', provides just the i2c-dev.h header file
776 for user space i2c development.
779 For querying iptables counters.
780 <http://netfilter.org/>
783 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
784 used by the `java' plugin to execute Java bytecode.
785 See docs/BUILD.java.md for detailed build instructions.
786 <http://openjdk.java.net/> (and others)
789 Used by the `openldap' plugin.
790 <http://www.openldap.org/>
793 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
794 <https://www.lua.org/>
797 Used by the `lvm' plugin.
798 <ftp://sources.redhat.com/pub/lvm2/>
800 * libmemcached (optional)
801 Used by the `memcachec' plugin to connect to a memcache daemon.
802 <http://tangent.org/552/libmemcached.html>
804 * libmicrohttpd (optional)
805 Used by the write_prometheus plugin to run an http daemon.
806 <http://www.gnu.org/software/libmicrohttpd/>
809 Used by the `netlink' plugin.
810 <http://www.netfilter.org/projects/libmnl/>
812 * libmodbus (optional)
813 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
814 `modbus' plugin works with version 2.0.3 of the library – due to frequent
815 API changes other versions may or may not compile cleanly.
816 <http://www.libmodbus.org/>
818 * libmysqlclient (optional)
819 Unsurprisingly used by the `mysql' plugin.
820 <http://dev.mysql.com/>
822 * libnetapp (optional)
823 Required for the `netapp' plugin.
824 This library is part of the “Manage ONTAP SDK” published by NetApp.
826 * libnetsnmp (optional)
827 For the `snmp' and 'snmp_agent' plugins.
828 <http://www.net-snmp.org/>
830 * libnetsnmpagent (optional)
831 Required for the 'snmp_agent' plugin.
832 <http://www.net-snmp.org/>
834 * libnotify (optional)
835 For the `notify_desktop' plugin.
836 <http://www.galago-project.org/>
838 * libopenipmi (optional)
839 Used by the `ipmi' plugin to prove IPMI devices.
840 <http://openipmi.sourceforge.net/>
842 * liboping (optional)
843 Used by the `ping' plugin to send and receive ICMP packets.
844 <http://octo.it/liboping/>
846 * libowcapi (optional)
847 Used by the `onewire' plugin to read values from onewire sensors (or the
849 <http://www.owfs.org/>
852 Used to capture packets by the `dns' plugin.
853 <http://www.tcpdump.org/>
855 * libperfstat (optional)
856 Used by various plugins to gather statistics under AIX.
859 Obviously used by the `perl' plugin. The library has to be compiled with
860 ithread support (introduced in Perl 5.6.0).
861 <http://www.perl.org/>
864 The PostgreSQL C client library used by the `postgresql' plugin.
865 <http://www.postgresql.org/>
868 The PQoS library for Intel(R) Resource Director Technology used by the
870 <https://github.com/01org/intel-cmt-cat>
872 * libprotobuf, protoc 3.0+ (optional)
873 Used by the `grpc' plugin to generate service stubs and code to handle
874 network packets of collectd's protobuf-based network protocol.
875 <https://developers.google.com/protocol-buffers/>
877 * libprotobuf-c, protoc-c (optional)
878 Used by the `pinba' plugin to generate a parser for the network packets
879 sent by the Pinba PHP extension.
880 <http://code.google.com/p/protobuf-c/>
882 * libpython (optional)
883 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
885 <http://www.python.org/>
887 * librabbitmq (optional; also called “rabbitmq-c”)
888 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
889 <http://hg.rabbitmq.com/rabbitmq-c/>
891 * librdkafka (optional; also called “rdkafka”)
892 Used by the `write_kafka' plugin for producing messages and sending them
894 <https://github.com/edenhill/librdkafka>
896 * librouteros (optional)
897 Used by the `routeros' plugin to connect to a device running `RouterOS'.
898 <http://octo.it/librouteros/>
901 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
902 client support which was added after version 1.3 of RRDtool. Versions 1.0,
903 1.2 and 1.3 are known to work with the `rrdtool' plugin.
904 <http://oss.oetiker.ch/rrdtool/>
906 * librt, libsocket, libkstat, libdevinfo (optional)
907 Various standard Solaris libraries which provide system functions.
908 <http://developers.sun.com/solaris/>
910 * libsensors (optional)
911 To read from `lm_sensors', see the `sensors' plugin.
912 <http://www.lm-sensors.org/>
914 * libsigrok (optional)
915 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
916 libzip, and optionally (depending on which drivers are enabled) on
917 libusb, libftdi and libudev.
919 * libstatgrab (optional)
920 Used by various plugins to collect statistics on systems other than Linux
922 <http://www.i-scream.org/libstatgrab/>
924 * libtokyotyrant (optional)
925 Used by the `tokyotyrant' plugin.
926 <http://1978th.net/tokyotyrant/>
928 * libupsclient/nut (optional)
929 For the `nut' plugin which queries nut's `upsd'.
930 <http://networkupstools.org/>
933 Collect statistics from virtual machines.
934 <http://libvirt.org/>
937 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
939 <http://xmlsoft.org/>
942 Used by the `xencpu' plugin.
943 <http://xenbits.xensource.com/>
946 <http://www.xmms.org/>
949 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events'
950 and `log_logstash' plugins.
951 <http://github.com/lloyd/yajl>
953 * libvarnish (optional)
954 Fetches statistics from a Varnish instance. This is needed for the
956 <http://varnish-cache.org>
958 * riemann-c-client (optional)
959 For the `write_riemann' plugin.
960 <https://github.com/algernon/riemann-c-client>
962 Configuring / Compiling / Installing
963 ------------------------------------
965 To configure, build and install collectd with the default settings, run
966 `./configure && make && make install'. For detailed, generic instructions
967 see INSTALL. For a complete list of configure options and their description,
968 run `./configure --help'.
970 By default, the configure script will check for all build dependencies and
971 disable all plugins whose requirements cannot be fulfilled (any other plugin
972 will be enabled). To enable a plugin, install missing dependencies (see
973 section `Prerequisites' above) and rerun `configure'. If you specify the
974 `--enable-<plugin>' configure option, the script will fail if the depen-
975 dencies for the specified plugin are not met. In that case you can force the
976 plugin to be built using the `--enable-<plugin>=force' configure option.
977 This will most likely fail though unless you're working in a very unusual
978 setup and you really know what you're doing. If you specify the
979 `--disable-<plugin>' configure option, the plugin will not be built. If you
980 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
981 options, all plugins will be enabled or disabled respectively by default.
982 Explicitly enabling or disabling a plugin overwrites the default for the
983 specified plugin. These options are meant for package maintainers and should
984 not be used in everyday situations.
986 By default, collectd will be installed into `/opt/collectd'. You can adjust
987 this setting by specifying the `--prefix' configure option - see INSTALL for
988 details. If you pass DESTDIR=<path> to `make install', <path> will be
989 prefixed to all installation directories. This might be useful when creating
990 packages for collectd.
992 Generating the configure script
993 -------------------------------
995 Collectd ships with a `build.sh' script to generate the `configure'
996 script shipped with releases.
998 To generate the `configure` script, you'll need the following dependencies:
1007 The `build.sh' script takes no arguments.
1013 To compile correctly collectd needs to be able to initialize static
1014 variables to NAN (Not A Number). Some C libraries, especially the GNU
1015 libc, have a problem with that.
1017 Luckily, with GCC it's possible to work around that problem: One can define
1018 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1019 ``implementation'' the configure script needs to compile and run a short
1020 test program. Obviously running a test program when doing a cross-
1021 compilation is, well, challenging.
1023 If you run into this problem, you can use the `--with-nan-emulation'
1024 configure option to force the use of this implementation. We can't promise
1025 that the compiled binary actually behaves as it should, but since NANs
1026 are likely never passed to the libm you have a good chance to be lucky.
1028 Likewise, collectd needs to know the layout of doubles in memory, in order
1029 to craft uniform network packets over different architectures. For this, it
1030 needs to know how to convert doubles into the memory layout used by x86. The
1031 configure script tries to figure this out by compiling and running a few
1032 small test programs. This is of course not possible when cross-compiling.
1033 You can use the `--with-fp-layout' option to tell the configure script which
1034 conversion method to assume. Valid arguments are:
1036 * `nothing' (12345678 -> 12345678)
1037 * `endianflip' (12345678 -> 87654321)
1038 * `intswap' (12345678 -> 56781234)
1044 Please use GitHub to report bugs and submit pull requests:
1045 <https://github.com/collectd/collectd/>.
1046 See CONTRIBUTING.md for details.
1048 For questions, development information and basically all other concerns please
1049 send an email to collectd's mailing list at
1050 <list at collectd.org>.
1052 For live discussion and more personal contact visit us in IRC, we're in
1053 channel #collectd on freenode.
1059 Florian octo Forster <octo at collectd.org>,
1060 Sebastian tokkee Harl <sh at tokkee.org>,
1061 and many contributors (see `AUTHORS').
projects / collectd.git / blob