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 Event-based interface status.
61 Number of nf_conntrack entries.
64 Number of context switches done by the operating system.
67 CPU utilization: Time spent in the system, user, nice, idle, and related
71 CPU frequency (For laptops with speed step or a similar technology)
74 CPU sleep: Time spent in suspend (For mobile devices which enter suspend automatically)
77 Parse statistics from websites using regular expressions.
80 Retrieves JSON data via cURL and parses it according to user
84 Retrieves XML data via cURL and parses it according to user
88 Executes SQL statements on various databases and interprets the returned
92 Mountpoint usage (Basically the values `df(1)' delivers)
95 Disk utilization: Sectors read/written, number of read/write actions,
96 average time an IO-operation took to complete.
99 DNS traffic: Query types, response codes, opcodes and traffic/octets
103 Collect DPDK interface statistics.
104 See docs/BUILD.dpdkstat.md for detailed build instructions.
107 Collect individual drbd resource statistics.
110 Email statistics: Count, traffic, spam scores and checks.
111 See collectd-email(5).
114 Amount of entropy available to the system.
117 Network interface card statistics.
120 Values gathered by a custom program or script.
121 See collectd-exec(5).
124 File handles statistics.
127 Count the number of files in directories.
130 Linux file-system based caching framework statistics.
133 Receive multicast traffic from Ganglia instances.
136 Monitor gps related data through gpsd.
139 Hard disk temperatures using hddtempd.
142 Report the number of used and free hugepages. More info on
143 hugepages can be found here:
144 https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt.
147 The intel_pmu plugin reads performance counters provided by the Linux
148 kernel perf interface. The plugin uses jevents library to resolve named
149 events to perf events and access perf interface.
152 The intel_rdt plugin collects information provided by monitoring features
153 of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
154 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features
155 provide information about utilization of shared resources like last level
156 cache occupancy, local memory bandwidth usage, remote memory bandwidth
157 usage, instructions per clock.
158 <https://01.org/packet-processing/cache-monitoring-technology-memory-bandwidth-monitoring-cache-allocation-technology-code-and-data>
161 Interface traffic: Number of octets, packets and errors for each
165 IPC counters: semaphores used, number of allocated segments in shared
169 IPMI (Intelligent Platform Management Interface) sensors information.
172 Iptables' counters: Number of bytes that were matched by a certain
176 IPVS connection statistics (number of connections, octets and packets
177 for each service and destination).
178 See http://www.linuxvirtualserver.org/software/index.html.
181 IRQ counters: Frequency in which certain interrupts occur.
184 Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
186 See docs/BUILD.java.md for detailed build instructions.
189 System load average over the last 1, 5 and 15 minutes.
192 Detailed CPU statistics of the “Logical Partitions” virtualization
193 technique built into IBM's POWER processors.
196 The Lua plugin implements a Lua interpreter into collectd. This
197 makes it possible to write plugins in Lua which are executed by
198 collectd without the need to start a heavy interpreter every interval.
199 See collectd-lua(5) for details.
202 Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
203 “Logical Volume Manager” (LVM).
206 Queries very detailed usage statistics from wireless LAN adapters and
207 interfaces that use the Atheros chipset and the MadWifi driver.
210 Motherboard sensors: temperature, fan speed and voltage information,
214 Monitor machine check exceptions (hardware errors detected by hardware
215 and reported to software) reported by mcelog and generate appropriate
216 notifications when machine check exceptions are detected.
219 Linux software-RAID device information (number of active, failed, spare
223 Query and parse data from a memcache daemon (memcached).
226 Statistics of the memcached distributed caching system.
227 <http://www.danga.com/memcached/>
230 Memory utilization: Memory occupied by running processes, page cache,
231 buffer cache and free.
234 Collects CPU usage, memory usage, temperatures and power consumption from
235 Intel Many Integrated Core (MIC) CPUs.
238 Reads values from Modbus/TCP enabled devices. Supports reading values
239 from multiple "slaves" so gateway devices can be used.
242 Information provided by serial multimeters, such as the `Metex
246 MySQL server statistics: Commands issued, handlers triggered, thread
247 usage, query cache utilization and traffic/octets sent and received.
250 Plugin to query performance values from a NetApp storage system using the
251 “Manage ONTAP” SDK provided by NetApp.
254 Very detailed Linux network interface and routing statistics. You can get
255 (detailed) information on interfaces, qdiscs, classes, and, if you can
256 make use of it, filters.
259 Receive values that were collected by other hosts. Large setups will
260 want to collect the data on one dedicated machine, and this is the
261 plugin of choice for that.
264 NFS Procedures: Which NFS command were called how often.
267 Collects statistics from `nginx' (speak: engine X), a HTTP and mail
271 NTP daemon statistics: Local clock drift, offset to peers, etc.
274 Information about Non-Uniform Memory Access (NUMA).
277 Network UPS tools: UPS current, voltage, power, charge, utilisation,
278 temperature, etc. See upsd(8).
281 Queries routing information from the “Optimized Link State Routing”
284 - onewire (EXPERIMENTAL!)
285 Read onewire sensors using the owcapu library of the owfs project.
286 Please read in collectd.conf(5) why this plugin is experimental.
289 Read monitoring information from OpenLDAP's cn=Monitor subtree.
292 RX and TX of each client in openvpn-status.log (status-version 2).
293 <http://openvpn.net/index.php/documentation/howto.html>
296 Query data from an Oracle database.
299 The plugin monitors the link status of Open vSwitch (OVS) connected
300 interfaces, dispatches the values to collectd and sends the notification
301 whenever the link state change occurs in the OVS database. It requires
302 YAJL library to be installed.
303 Detailed instructions for installing and setting up Open vSwitch, see
305 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
308 The plugin collects the statistics of OVS connected bridges and
309 interfaces. It requires YAJL library to be installed.
310 Detailed instructions for installing and setting up Open vSwitch, see
312 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
315 The perl plugin implements a Perl-interpreter into collectd. You can
316 write your own plugins in Perl and return arbitrary values using this
317 API. See collectd-perl(5).
320 Query statistics from BSD's packet filter "pf".
323 Receive and dispatch timing values from Pinba, a profiling extension for
327 Network latency: Time to reach the default gateway or another given
331 PostgreSQL database statistics: active server connections, transaction
332 numbers, block IO, table row manipulations.
335 PowerDNS name server statistics.
338 Process counts: Number of running, sleeping, zombie, ... processes.
341 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
344 The python plugin implements a Python interpreter into collectd. This
345 makes it possible to write plugins in Python which are executed by
346 collectd without the need to start a heavy interpreter every interval.
347 See collectd-python(5) for details.
350 The redis plugin gathers information from a Redis server, including:
351 uptime, used memory, total connections etc.
354 Query interface and wireless registration statistics from RouterOS.
357 RRDtool caching daemon (RRDcacheD) statistics.
360 System sensors, accessed using lm_sensors: Voltages, temperatures and
364 RX and TX of serial interfaces. Linux only; needs root privileges.
367 Uses libsigrok as a backend, allowing any sigrok-supported device
368 to have its measurements fed to collectd. This includes multimeters,
369 sound level meters, thermometers, and much more.
372 Collect SMART statistics, notably load cycle count, temperature
376 Read values from SNMP (Simple Network Management Protocol) enabled
377 network devices such as switches, routers, thermometers, rack monitoring
378 servers, etc. See collectd-snmp(5).
381 Acts as a StatsD server, reading values sent over the network from StatsD
382 clients and calculating rates and other aggregates out of these values.
385 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
388 Parse table-like structured files.
391 Follows (tails) log files, parses them by lines and submits matched
395 Follows (tails) files in CSV format, parses each line and submits
399 Bytes and operations read and written on tape devices. Solaris only.
402 Number of TCP connections to specific local and remote ports.
405 TeamSpeak2 server statistics.
408 Plugin to read values from `The Energy Detective' (TED).
411 Linux ACPI thermal zone information.
414 Reads the number of records and file size from a running Tokyo Tyrant
418 Reads CPU frequency and C-state residency on modern Intel
419 turbo-capable processors.
422 System uptime statistics.
425 Users currently logged in.
428 Various statistics from Varnish, an HTTP accelerator.
431 CPU, memory, disk and network I/O statistics from virtual machines.
434 Virtual memory statistics, e.g. the number of page-ins/-outs or the
435 number of pagefaults.
438 System resources used by Linux VServers.
439 See <http://linux-vserver.org/>.
442 Link quality of wireless cards. Linux only.
445 XEN Hypervisor CPU stats.
448 Bitrate and frequency of music played with XMMS.
451 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
454 Measures the percentage of cpu load per container (zone) under Solaris 10
458 Read data from Zookeeper's MNTR command.
460 * Output can be written or sent to various destinations by the following
464 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
465 server, such as RabbitMQ.
468 Write to comma separated values (CSV) files. This needs lots of
469 diskspace but is extremely portable and can be analysed with almost
470 every program that can analyse anything. Even Microsoft's Excel..
473 Send and receive values over the network using the gRPC framework.
476 It's possible to implement write plugins in Lua using the Lua
477 plugin. See collectd-lua(5) for details.
480 Publishes and subscribes to MQTT topics.
483 Send the data to a remote host to save the data somehow. This is useful
484 for large setups where the data should be saved by a dedicated machine.
487 Of course the values are propagated to plugins written in Perl, too, so
488 you can easily do weird stuff with the plugins we didn't dare think of
489 ;) See collectd-perl(5).
492 It's possible to implement write plugins in Python using the python
493 plugin. See collectd-python(5) for details.
496 Output to round-robin-database (RRD) files using the RRDtool caching
497 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
498 implementation of the caching done by the `rrdtool' plugin.
501 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
502 This is likely the most popular destination for such values. Since
503 updates to RRD-files are somewhat expensive this plugin can cache
504 updates to the files and write a bunch of updates at once, which lessens
508 Receives and handles queries from SNMP master agent and returns the data
509 collected by read plugins. Handles requests only for OIDs specified in
510 configuration file. To handle SNMP queries the plugin gets data from
511 collectd and translates requested values from collectd's internal format
515 One can query the values from the unixsock plugin whenever they're
516 needed. Please read collectd-unixsock(5) for a description on how that's
520 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
521 can be configured to avoid logging send errors (especially useful when
525 Sends the values collected by collectd to a web-server using HTTP POST
526 requests. The transmitted data is either in a form understood by the
527 Exec plugin or formatted in JSON.
530 Sends data to Apache Kafka, a distributed queue.
533 Writes data to the log
536 Sends data to MongoDB, a NoSQL database.
539 Publish values using an embedded HTTP server, in a format compatible
540 with Prometheus' collectd_exporter.
543 Sends the values to a Redis key-value database server.
546 Sends data to Riemann, a stream processing and monitoring system.
549 Sends data to Sensu, a stream processing and monitoring system, via the
550 Sensu client local TCP socket.
553 Sends data OpenTSDB, a scalable no master, no shared state time series
556 * Logging is, as everything in collectd, provided by plugins. The following
557 plugins keep us informed about what's going on:
560 Writes log messages to a file or STDOUT/STDERR.
563 Log messages are propagated to plugins written in Perl as well.
564 See collectd-perl(5).
567 It's possible to implement log plugins in Python using the python plugin.
568 See collectd-python(5) for details.
571 Logs to the standard UNIX logging mechanism, syslog.
574 Writes log messages formatted as logstash JSON events.
576 * Notifications can be handled by the following plugins:
579 Send a desktop notification to a notification daemon, as defined in
580 the Desktop Notification Specification. To actually display the
581 notifications, notification-daemon is required.
582 See http://www.galago-project.org/specs/notification/.
585 Send an E-mail with the notification message to the configured
589 Submit notifications as passive check results to a local nagios instance.
592 Execute a program or script to handle the notification.
593 See collectd-exec(5).
596 Writes the notification message to a file or STDOUT/STDERR.
599 Send the notification to a remote host to handle it somehow.
602 Notifications are propagated to plugins written in Perl as well.
603 See collectd-perl(5).
606 It's possible to implement notification plugins in Python using the
607 python plugin. See collectd-python(5) for details.
609 * Value processing can be controlled using the "filter chain" infrastructure
610 and "matches" and "targets". The following plugins are available:
612 - match_empty_counter
613 Match counter values which are currently zero.
616 Match values using a hash function of the hostname.
619 Match values by their identifier based on regular expressions.
622 Match values with an invalid timestamp.
625 Select values by their data sources' values.
627 - target_notification
628 Create and dispatch a notification.
631 Replace parts of an identifier using regular expressions.
634 Scale (multiply) values by an arbitrary value.
637 Set (overwrite) entire parts of an identifier.
639 * Miscellaneous plugins:
642 Selects multiple value lists based on patterns or regular expressions
643 and creates new aggregated values lists from those.
646 Checks values against configured thresholds and creates notifications if
647 values are out of bounds. See collectd-threshold(5) for details.
650 Sets the hostname to a unique identifier. This is meant for setups
651 where each client may migrate to another physical host, possibly going
652 through one or more name changes in the process.
654 * Performance: Since collectd is running as a daemon it doesn't spend much
655 time starting up again and again. With the exception of the exec plugin no
656 processes are forked. Caching in output plugins, such as the rrdtool and
657 network plugins, makes sure your resources are used efficiently. Also,
658 since collectd is programmed multithreaded it benefits from hyper-threading
659 and multicore processors and makes sure that the daemon isn't idle if only
660 one plugin waits for an IO-operation to complete.
662 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
663 as possible and the default values should be okay for most users.
669 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
670 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
671 for a list of options and a syntax description.
673 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
674 files. The usual place for these files is beneath `/var/lib/collectd'.
676 * When using some of the plugins, collectd needs to run as user root, since
677 only root can do certain things, such as craft ICMP packages needed to ping
678 other hosts. collectd should NOT be installed setuid root since it can be
679 used to overwrite valuable files!
681 * Sample scripts to generate graphs reside in `contrib/' in the source
682 package or somewhere near `/usr/share/doc/collectd' in most distributions.
683 Please be aware that those script are meant as a starting point for your
684 own experiments.. Some of them require the `RRDs' Perl module.
685 (`librrds-perl' on Debian) If you have written a more sophisticated
686 solution please share it with us.
688 * The RRAs of the automatically created RRD files depend on the `step'
689 and `heartbeat' settings given. If change these settings you may need to
690 re-create the files, losing all data. Please be aware of that when changing
691 the values and read the rrdtool(1) manpage thoroughly.
694 collectd and chkrootkit
695 -----------------------
697 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
698 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
699 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
700 this case, collectd is a legitimate sniffer and the report should be
701 considered to be a false positive. However, you might want to check that
702 this really is collectd and not some other, illegitimate sniffer.
708 To compile collectd from source you will need:
710 * Usual suspects: C compiler, linker, preprocessor, make, ...
712 collectd makes use of some common C99 features, e.g. compound literals and
713 mixed declarations, and therefore requires a C99 compatible compiler.
715 On Debian and Ubuntu, the "build-essential" package should pull in
716 everything that's necessary.
718 * A POSIX-threads (pthread) implementation.
719 Since gathering some statistics is slow (network connections, slow devices,
720 etc) collectd is parallelized. The POSIX threads interface is being
721 used and should be found in various implementations for hopefully all
724 * When building from the Git repository, flex (tokenizer) and bison (parser
725 generator) are required. Release tarballs include the generated files – you
726 don't need these packages in that case.
728 * aerotools-ng (optional)
729 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
730 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
731 nor does it feature an installation routine. Therefore, you need to point
732 collectd's configure script at the source directory of the `aerotools-ng'
734 <https://github.com/lynix/aerotools-ng>
736 * CoreFoundation.framework and IOKit.framework (optional)
737 For compiling on Darwin in general and the `apple_sensors' plugin in
739 <http://developer.apple.com/corefoundation/>
741 * libatasmart (optional)
742 Used by the `smart' plugin.
743 <http://git.0pointer.de/?p=libatasmart.git>
746 The `turbostat' plugin can optionally build Linux Capabilities support,
747 which avoids full privileges requirement (aka. running as root) to read
749 <http://sites.google.com/site/fullycapable/>
751 * libclntsh (optional)
752 Used by the `oracle' plugin.
754 * libhiredis (optional)
755 Used by the redis plugin. Please note that you require a 0.10.0 version
756 or higher. <https://github.com/redis/hiredis>
759 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
760 `curl_xml', `nginx', or `write_http' plugin.
761 <http://curl.haxx.se/>
764 Used by the `dbi' plugin to connect to various databases.
765 <http://libdbi.sourceforge.net/>
767 * libesmtp (optional)
768 For the `notify_email' plugin.
769 <http://www.stafford.uklinux.net/libesmtp/>
771 * libganglia (optional)
772 Used by the `gmond' plugin to process data received from Ganglia.
773 <http://ganglia.info/>
776 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
780 * libgcrypt (optional)
781 Used by the `network' plugin for encryption and authentication.
782 <http://www.gnupg.org/>
785 Used by the `gps' plugin.
786 <http://developer.berlios.de/projects/gpsd/>
788 * libi2c-dev (optional)
789 Used for the plugin `barometer', provides just the i2c-dev.h header file
790 for user space i2c development.
793 For querying iptables counters.
794 <http://netfilter.org/>
796 * libjevents (optional)
797 The jevents library is used by the `intel_pmu' plugin to access the Linux
798 kernel perf interface.
799 Note: the library should be build with -fPIC flag to be linked with
800 intel_pmu shared object correctly.
801 <https://github.com/andikleen/pmu-tools>
804 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
805 used by the `java' plugin to execute Java bytecode.
806 See docs/BUILD.java.md for detailed build instructions.
807 <http://openjdk.java.net/> (and others)
810 Used by the `openldap' plugin.
811 <http://www.openldap.org/>
814 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
815 <https://www.lua.org/>
818 Used by the `lvm' plugin.
819 <ftp://sources.redhat.com/pub/lvm2/>
821 * libmemcached (optional)
822 Used by the `memcachec' plugin to connect to a memcache daemon.
823 <http://tangent.org/552/libmemcached.html>
825 * libmicrohttpd (optional)
826 Used by the write_prometheus plugin to run an http daemon.
827 <http://www.gnu.org/software/libmicrohttpd/>
830 Used by the `netlink' plugin.
831 <http://www.netfilter.org/projects/libmnl/>
833 * libmodbus (optional)
834 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
835 `modbus' plugin works with version 2.0.3 of the library – due to frequent
836 API changes other versions may or may not compile cleanly.
837 <http://www.libmodbus.org/>
839 * libmysqlclient (optional)
840 Unsurprisingly used by the `mysql' plugin.
841 <http://dev.mysql.com/>
843 * libnetapp (optional)
844 Required for the `netapp' plugin.
845 This library is part of the “Manage ONTAP SDK” published by NetApp.
847 * libnetsnmp (optional)
848 For the `snmp' and 'snmp_agent' plugins.
849 <http://www.net-snmp.org/>
851 * libnetsnmpagent (optional)
852 Required for the 'snmp_agent' plugin.
853 <http://www.net-snmp.org/>
855 * libnotify (optional)
856 For the `notify_desktop' plugin.
857 <http://www.galago-project.org/>
859 * libopenipmi (optional)
860 Used by the `ipmi' plugin to prove IPMI devices.
861 <http://openipmi.sourceforge.net/>
863 * liboping (optional)
864 Used by the `ping' plugin to send and receive ICMP packets.
865 <http://octo.it/liboping/>
867 * libowcapi (optional)
868 Used by the `onewire' plugin to read values from onewire sensors (or the
870 <http://www.owfs.org/>
873 Used to capture packets by the `dns' plugin.
874 <http://www.tcpdump.org/>
876 * libperfstat (optional)
877 Used by various plugins to gather statistics under AIX.
880 Obviously used by the `perl' plugin. The library has to be compiled with
881 ithread support (introduced in Perl 5.6.0).
882 <http://www.perl.org/>
885 The PostgreSQL C client library used by the `postgresql' plugin.
886 <http://www.postgresql.org/>
889 The PQoS library for Intel(R) Resource Director Technology used by the
891 <https://github.com/01org/intel-cmt-cat>
893 * libprotobuf, protoc 3.0+ (optional)
894 Used by the `grpc' plugin to generate service stubs and code to handle
895 network packets of collectd's protobuf-based network protocol.
896 <https://developers.google.com/protocol-buffers/>
898 * libprotobuf-c, protoc-c (optional)
899 Used by the `pinba' plugin to generate a parser for the network packets
900 sent by the Pinba PHP extension.
901 <http://code.google.com/p/protobuf-c/>
903 * libpython (optional)
904 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
906 <http://www.python.org/>
908 * librabbitmq (optional; also called “rabbitmq-c”)
909 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
910 <http://hg.rabbitmq.com/rabbitmq-c/>
912 * librdkafka (optional; also called “rdkafka”)
913 Used by the `write_kafka' plugin for producing messages and sending them
915 <https://github.com/edenhill/librdkafka>
917 * librouteros (optional)
918 Used by the `routeros' plugin to connect to a device running `RouterOS'.
919 <http://octo.it/librouteros/>
922 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
923 client support which was added after version 1.3 of RRDtool. Versions 1.0,
924 1.2 and 1.3 are known to work with the `rrdtool' plugin.
925 <http://oss.oetiker.ch/rrdtool/>
927 * librt, libsocket, libkstat, libdevinfo (optional)
928 Various standard Solaris libraries which provide system functions.
929 <http://developers.sun.com/solaris/>
931 * libsensors (optional)
932 To read from `lm_sensors', see the `sensors' plugin.
933 <http://www.lm-sensors.org/>
935 * libsigrok (optional)
936 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
937 libzip, and optionally (depending on which drivers are enabled) on
938 libusb, libftdi and libudev.
940 * libstatgrab (optional)
941 Used by various plugins to collect statistics on systems other than Linux
943 <http://www.i-scream.org/libstatgrab/>
945 * libtokyotyrant (optional)
946 Used by the `tokyotyrant' plugin.
947 <http://1978th.net/tokyotyrant/>
949 * libupsclient/nut (optional)
950 For the `nut' plugin which queries nut's `upsd'.
951 <http://networkupstools.org/>
954 Collect statistics from virtual machines.
955 <http://libvirt.org/>
958 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
960 <http://xmlsoft.org/>
963 Used by the `xencpu' plugin.
964 <http://xenbits.xensource.com/>
967 <http://www.xmms.org/>
970 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
971 'ovs_stats' and `log_logstash' plugins.
972 <http://github.com/lloyd/yajl>
974 * libvarnish (optional)
975 Fetches statistics from a Varnish instance. This is needed for the
977 <http://varnish-cache.org>
979 * riemann-c-client (optional)
980 For the `write_riemann' plugin.
981 <https://github.com/algernon/riemann-c-client>
983 Configuring / Compiling / Installing
984 ------------------------------------
986 To configure, build and install collectd with the default settings, run
987 `./configure && make && make install'. For detailed, generic instructions
988 see INSTALL. For a complete list of configure options and their description,
989 run `./configure --help'.
991 By default, the configure script will check for all build dependencies and
992 disable all plugins whose requirements cannot be fulfilled (any other plugin
993 will be enabled). To enable a plugin, install missing dependencies (see
994 section `Prerequisites' above) and rerun `configure'. If you specify the
995 `--enable-<plugin>' configure option, the script will fail if the depen-
996 dencies for the specified plugin are not met. In that case you can force the
997 plugin to be built using the `--enable-<plugin>=force' configure option.
998 This will most likely fail though unless you're working in a very unusual
999 setup and you really know what you're doing. If you specify the
1000 `--disable-<plugin>' configure option, the plugin will not be built. If you
1001 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
1002 options, all plugins will be enabled or disabled respectively by default.
1003 Explicitly enabling or disabling a plugin overwrites the default for the
1004 specified plugin. These options are meant for package maintainers and should
1005 not be used in everyday situations.
1007 By default, collectd will be installed into `/opt/collectd'. You can adjust
1008 this setting by specifying the `--prefix' configure option - see INSTALL for
1009 details. If you pass DESTDIR=<path> to `make install', <path> will be
1010 prefixed to all installation directories. This might be useful when creating
1011 packages for collectd.
1013 Generating the configure script
1014 -------------------------------
1016 Collectd ships with a `build.sh' script to generate the `configure'
1017 script shipped with releases.
1019 To generate the `configure` script, you'll need the following dependencies:
1028 The `build.sh' script takes no arguments.
1034 To compile correctly collectd needs to be able to initialize static
1035 variables to NAN (Not A Number). Some C libraries, especially the GNU
1036 libc, have a problem with that.
1038 Luckily, with GCC it's possible to work around that problem: One can define
1039 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1040 ``implementation'' the configure script needs to compile and run a short
1041 test program. Obviously running a test program when doing a cross-
1042 compilation is, well, challenging.
1044 If you run into this problem, you can use the `--with-nan-emulation'
1045 configure option to force the use of this implementation. We can't promise
1046 that the compiled binary actually behaves as it should, but since NANs
1047 are likely never passed to the libm you have a good chance to be lucky.
1049 Likewise, collectd needs to know the layout of doubles in memory, in order
1050 to craft uniform network packets over different architectures. For this, it
1051 needs to know how to convert doubles into the memory layout used by x86. The
1052 configure script tries to figure this out by compiling and running a few
1053 small test programs. This is of course not possible when cross-compiling.
1054 You can use the `--with-fp-layout' option to tell the configure script which
1055 conversion method to assume. Valid arguments are:
1057 * `nothing' (12345678 -> 12345678)
1058 * `endianflip' (12345678 -> 87654321)
1059 * `intswap' (12345678 -> 56781234)
1065 Please use GitHub to report bugs and submit pull requests:
1066 <https://github.com/collectd/collectd/>.
1067 See CONTRIBUTING.md for details.
1069 For questions, development information and basically all other concerns please
1070 send an email to collectd's mailing list at
1071 <list at collectd.org>.
1073 For live discussion and more personal contact visit us in IRC, we're in
1074 channel #collectd on freenode.
1080 Florian octo Forster <octo at collectd.org>,
1081 Sebastian tokkee Harl <sh at tokkee.org>,
1082 and many contributors (see `AUTHORS').
projects / collectd.git / blob