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.
103 This plugin should be compiled with compiler defenses enabled, for
104 example -fstack-protector.
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 Monitor NVIDIA GPU statistics available through NVML.
142 Hard disk temperatures using hddtempd.
145 Report the number of used and free hugepages. More info on
146 hugepages can be found here:
147 https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt.
149 This plugin should be compiled with compiler defenses enabled, for
150 example -fstack-protector.
153 The intel_pmu plugin reads performance counters provided by the Linux
154 kernel perf interface. The plugin uses jevents library to resolve named
155 events to perf events and access perf interface.
158 The intel_rdt plugin collects information provided by monitoring features
159 of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
160 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features
161 provide information about utilization of shared resources like last level
162 cache occupancy, local memory bandwidth usage, remote memory bandwidth
163 usage, instructions per clock.
164 <https://01.org/packet-processing/cache-monitoring-technology-memory-bandwidth-monitoring-cache-allocation-technology-code-and-data>
167 Interface traffic: Number of octets, packets and errors for each
171 IPC counters: semaphores used, number of allocated segments in shared
175 IPMI (Intelligent Platform Management Interface) sensors information.
178 Iptables' counters: Number of bytes that were matched by a certain
182 IPVS connection statistics (number of connections, octets and packets
183 for each service and destination).
184 See http://www.linuxvirtualserver.org/software/index.html.
187 IRQ counters: Frequency in which certain interrupts occur.
190 Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
192 See docs/BUILD.java.md for detailed build instructions.
195 System load average over the last 1, 5 and 15 minutes.
198 Detailed CPU statistics of the “Logical Partitions” virtualization
199 technique built into IBM's POWER processors.
202 The Lua plugin implements a Lua interpreter into collectd. This
203 makes it possible to write plugins in Lua which are executed by
204 collectd without the need to start a heavy interpreter every interval.
205 See collectd-lua(5) for details.
208 Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
209 “Logical Volume Manager” (LVM).
212 Queries very detailed usage statistics from wireless LAN adapters and
213 interfaces that use the Atheros chipset and the MadWifi driver.
216 Motherboard sensors: temperature, fan speed and voltage information,
220 Monitor machine check exceptions (hardware errors detected by hardware
221 and reported to software) reported by mcelog and generate appropriate
222 notifications when machine check exceptions are detected.
225 Linux software-RAID device information (number of active, failed, spare
229 Query and parse data from a memcache daemon (memcached).
232 Statistics of the memcached distributed caching system.
233 <http://www.danga.com/memcached/>
236 Memory utilization: Memory occupied by running processes, page cache,
237 buffer cache and free.
240 Collects CPU usage, memory usage, temperatures and power consumption from
241 Intel Many Integrated Core (MIC) CPUs.
244 Reads values from Modbus/TCP enabled devices. Supports reading values
245 from multiple "slaves" so gateway devices can be used.
248 Information provided by serial multimeters, such as the `Metex
252 MySQL server statistics: Commands issued, handlers triggered, thread
253 usage, query cache utilization and traffic/octets sent and received.
256 Plugin to query performance values from a NetApp storage system using the
257 “Manage ONTAP” SDK provided by NetApp.
260 Very detailed Linux network interface and routing statistics. You can get
261 (detailed) information on interfaces, qdiscs, classes, and, if you can
262 make use of it, filters.
265 Receive values that were collected by other hosts. Large setups will
266 want to collect the data on one dedicated machine, and this is the
267 plugin of choice for that.
270 NFS Procedures: Which NFS command were called how often.
273 Collects statistics from `nginx' (speak: engine X), a HTTP and mail
277 NTP daemon statistics: Local clock drift, offset to peers, etc.
280 Information about Non-Uniform Memory Access (NUMA).
283 Network UPS tools: UPS current, voltage, power, charge, utilisation,
284 temperature, etc. See upsd(8).
287 Queries routing information from the “Optimized Link State Routing”
290 - onewire (EXPERIMENTAL!)
291 Read onewire sensors using the owcapu library of the owfs project.
292 Please read in collectd.conf(5) why this plugin is experimental.
295 Read monitoring information from OpenLDAP's cn=Monitor subtree.
298 RX and TX of each client in openvpn-status.log (status-version 2).
299 <http://openvpn.net/index.php/documentation/howto.html>
302 Query data from an Oracle database.
305 The plugin monitors the link status of Open vSwitch (OVS) connected
306 interfaces, dispatches the values to collectd and sends the notification
307 whenever the link state change occurs in the OVS database. It requires
308 YAJL library to be installed.
309 Detailed instructions for installing and setting up Open vSwitch, see
311 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
314 The plugin collects the statistics of OVS connected bridges and
315 interfaces. It requires YAJL library to be installed.
316 Detailed instructions for installing and setting up Open vSwitch, see
318 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
321 Read errors from PCI Express Device Status and AER extended capabilities.
322 <https://www.design-reuse.com/articles/38374/pcie-error-logging-and-handling-on-a-typical-soc.html>
325 The perl plugin implements a Perl-interpreter into collectd. You can
326 write your own plugins in Perl and return arbitrary values using this
327 API. See collectd-perl(5).
330 Query statistics from BSD's packet filter "pf".
333 Receive and dispatch timing values from Pinba, a profiling extension for
337 Network latency: Time to reach the default gateway or another given
341 PostgreSQL database statistics: active server connections, transaction
342 numbers, block IO, table row manipulations.
345 PowerDNS name server statistics.
348 Process counts: Number of running, sleeping, zombie, ... processes.
351 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
354 The python plugin implements a Python interpreter into collectd. This
355 makes it possible to write plugins in Python which are executed by
356 collectd without the need to start a heavy interpreter every interval.
357 See collectd-python(5) for details.
360 The redis plugin gathers information from a Redis server, including:
361 uptime, used memory, total connections etc.
364 Query interface and wireless registration statistics from RouterOS.
367 RRDtool caching daemon (RRDcacheD) statistics.
370 System sensors, accessed using lm_sensors: Voltages, temperatures and
374 RX and TX of serial interfaces. Linux only; needs root privileges.
377 Uses libsigrok as a backend, allowing any sigrok-supported device
378 to have its measurements fed to collectd. This includes multimeters,
379 sound level meters, thermometers, and much more.
382 Collect SMART statistics, notably load cycle count, temperature
386 Read values from SNMP (Simple Network Management Protocol) enabled
387 network devices such as switches, routers, thermometers, rack monitoring
388 servers, etc. See collectd-snmp(5).
391 Acts as a StatsD server, reading values sent over the network from StatsD
392 clients and calculating rates and other aggregates out of these values.
395 Listens to rsyslog events and submits matched values.
398 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
401 Parse table-like structured files.
404 Follows (tails) log files, parses them by lines and submits matched
408 Follows (tails) files in CSV format, parses each line and submits
412 Bytes and operations read and written on tape devices. Solaris only.
415 Number of TCP connections to specific local and remote ports.
418 TeamSpeak2 server statistics.
421 Plugin to read values from `The Energy Detective' (TED).
424 Linux ACPI thermal zone information.
427 Reads the number of records and file size from a running Tokyo Tyrant
431 Reads CPU frequency and C-state residency on modern Intel
432 turbo-capable processors.
435 System uptime statistics.
438 Users currently logged in.
441 Various statistics from Varnish, an HTTP accelerator.
444 CPU, memory, disk and network I/O statistics from virtual machines.
447 Virtual memory statistics, e.g. the number of page-ins/-outs or the
448 number of pagefaults.
451 System resources used by Linux VServers.
452 See <http://linux-vserver.org/>.
455 Link quality of wireless cards. Linux only.
458 XEN Hypervisor CPU stats.
461 Bitrate and frequency of music played with XMMS.
464 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
467 Measures the percentage of cpu load per container (zone) under Solaris 10
471 Read data from Zookeeper's MNTR command.
473 * Output can be written or sent to various destinations by the following
477 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
478 0.9.1 server, such as RabbitMQ.
481 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
482 1.0 server, such as Qpid Dispatch Router or Apache Artemis Broker.
485 Write to comma separated values (CSV) files. This needs lots of
486 diskspace but is extremely portable and can be analysed with almost
487 every program that can analyse anything. Even Microsoft's Excel..
490 Send and receive values over the network using the gRPC framework.
493 It's possible to implement write plugins in Lua using the Lua
494 plugin. See collectd-lua(5) for details.
497 Publishes and subscribes to MQTT topics.
500 Send the data to a remote host to save the data somehow. This is useful
501 for large setups where the data should be saved by a dedicated machine.
504 Of course the values are propagated to plugins written in Perl, too, so
505 you can easily do weird stuff with the plugins we didn't dare think of
506 ;) See collectd-perl(5).
509 It's possible to implement write plugins in Python using the python
510 plugin. See collectd-python(5) for details.
513 Output to round-robin-database (RRD) files using the RRDtool caching
514 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
515 implementation of the caching done by the `rrdtool' plugin.
518 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
519 This is likely the most popular destination for such values. Since
520 updates to RRD-files are somewhat expensive this plugin can cache
521 updates to the files and write a bunch of updates at once, which lessens
525 Receives and handles queries from SNMP master agent and returns the data
526 collected by read plugins. Handles requests only for OIDs specified in
527 configuration file. To handle SNMP queries the plugin gets data from
528 collectd and translates requested values from collectd's internal format
532 One can query the values from the unixsock plugin whenever they're
533 needed. Please read collectd-unixsock(5) for a description on how that's
537 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
538 can be configured to avoid logging send errors (especially useful when
542 Sends the values collected by collectd to a web-server using HTTP POST
543 requests. The transmitted data is either in a form understood by the
544 Exec plugin or formatted in JSON.
547 Sends data to Apache Kafka, a distributed queue.
550 Writes data to the log
553 Sends data to MongoDB, a NoSQL database.
556 Publish values using an embedded HTTP server, in a format compatible
557 with Prometheus' collectd_exporter.
560 Sends the values to a Redis key-value database server.
563 Sends data to Riemann, a stream processing and monitoring system.
566 Sends data to Sensu, a stream processing and monitoring system, via the
567 Sensu client local TCP socket.
570 Sends data in syslog format, using TCP, where the message
571 contains the metric in human or JSON format.
574 Sends data OpenTSDB, a scalable no master, no shared state time series
577 * Logging is, as everything in collectd, provided by plugins. The following
578 plugins keep us informed about what's going on:
581 Writes log messages to a file or STDOUT/STDERR.
584 Log messages are propagated to plugins written in Perl as well.
585 See collectd-perl(5).
588 It's possible to implement log plugins in Python using the python plugin.
589 See collectd-python(5) for details.
592 Logs to the standard UNIX logging mechanism, syslog.
595 Writes log messages formatted as logstash JSON events.
597 * Notifications can be handled by the following plugins:
600 Send a desktop notification to a notification daemon, as defined in
601 the Desktop Notification Specification. To actually display the
602 notifications, notification-daemon is required.
603 See http://www.galago-project.org/specs/notification/.
606 Send an E-mail with the notification message to the configured
610 Submit notifications as passive check results to a local nagios instance.
613 Execute a program or script to handle the notification.
614 See collectd-exec(5).
617 Writes the notification message to a file or STDOUT/STDERR.
620 Send the notification to a remote host to handle it somehow.
623 Notifications are propagated to plugins written in Perl as well.
624 See collectd-perl(5).
627 It's possible to implement notification plugins in Python using the
628 python plugin. See collectd-python(5) for details.
630 * Value processing can be controlled using the "filter chain" infrastructure
631 and "matches" and "targets". The following plugins are available:
633 - match_empty_counter
634 Match counter values which are currently zero.
637 Match values using a hash function of the hostname.
640 Match values by their identifier based on regular expressions.
643 Match values with an invalid timestamp.
646 Select values by their data sources' values.
648 - target_notification
649 Create and dispatch a notification.
652 Replace parts of an identifier using regular expressions.
655 Scale (multiply) values by an arbitrary value.
658 Set (overwrite) entire parts of an identifier.
660 * Miscellaneous plugins:
663 Selects multiple value lists based on patterns or regular expressions
664 and creates new aggregated values lists from those.
667 Checks values against configured thresholds and creates notifications if
668 values are out of bounds. See collectd-threshold(5) for details.
671 Sets the hostname to a unique identifier. This is meant for setups
672 where each client may migrate to another physical host, possibly going
673 through one or more name changes in the process.
675 * Performance: Since collectd is running as a daemon it doesn't spend much
676 time starting up again and again. With the exception of the exec plugin no
677 processes are forked. Caching in output plugins, such as the rrdtool and
678 network plugins, makes sure your resources are used efficiently. Also,
679 since collectd is programmed multithreaded it benefits from hyper-threading
680 and multicore processors and makes sure that the daemon isn't idle if only
681 one plugin waits for an IO-operation to complete.
683 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
684 as possible and the default values should be okay for most users.
690 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
691 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
692 for a list of options and a syntax description.
694 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
695 files. The usual place for these files is beneath `/var/lib/collectd'.
697 * When using some of the plugins, collectd needs to run as user root, since
698 only root can do certain things, such as craft ICMP packages needed to ping
699 other hosts. collectd should NOT be installed setuid root since it can be
700 used to overwrite valuable files!
702 * Sample scripts to generate graphs reside in `contrib/' in the source
703 package or somewhere near `/usr/share/doc/collectd' in most distributions.
704 Please be aware that those script are meant as a starting point for your
705 own experiments.. Some of them require the `RRDs' Perl module.
706 (`librrds-perl' on Debian) If you have written a more sophisticated
707 solution please share it with us.
709 * The RRAs of the automatically created RRD files depend on the `step'
710 and `heartbeat' settings given. If change these settings you may need to
711 re-create the files, losing all data. Please be aware of that when changing
712 the values and read the rrdtool(1) manpage thoroughly.
715 collectd and chkrootkit
716 -----------------------
718 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
719 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
720 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
721 this case, collectd is a legitimate sniffer and the report should be
722 considered to be a false positive. However, you might want to check that
723 this really is collectd and not some other, illegitimate sniffer.
729 To compile collectd from source you will need:
731 * Usual suspects: C compiler, linker, preprocessor, make, ...
733 collectd makes use of some common C99 features, e.g. compound literals and
734 mixed declarations, and therefore requires a C99 compatible compiler.
736 On Debian and Ubuntu, the "build-essential" package should pull in
737 everything that's necessary.
739 * A POSIX-threads (pthread) implementation.
740 Since gathering some statistics is slow (network connections, slow devices,
741 etc) collectd is parallelized. The POSIX threads interface is being
742 used and should be found in various implementations for hopefully all
745 * When building from the Git repository, flex (tokenizer) and bison (parser
746 generator) are required. Release tarballs include the generated files – you
747 don't need these packages in that case.
749 * aerotools-ng (optional)
750 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
751 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
752 nor does it feature an installation routine. Therefore, you need to point
753 collectd's configure script at the source directory of the `aerotools-ng'
755 <https://github.com/lynix/aerotools-ng>
757 * CoreFoundation.framework and IOKit.framework (optional)
758 For compiling on Darwin in general and the `apple_sensors' plugin in
760 <http://developer.apple.com/corefoundation/>
763 Used by the `gpu_nvidia' plugin
764 <https://developer.nvidia.com/cuda-downloads>
766 * libatasmart (optional)
767 Used by the `smart' plugin.
768 <http://git.0pointer.de/?p=libatasmart.git>
771 The `turbostat' plugin can optionally build Linux Capabilities support,
772 which avoids full privileges requirement (aka. running as root) to read
774 <http://sites.google.com/site/fullycapable/>
776 * libclntsh (optional)
777 Used by the `oracle' plugin.
779 * libhiredis (optional)
780 Used by the redis plugin. Please note that you require a 0.10.0 version
781 or higher. <https://github.com/redis/hiredis>
784 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
785 `curl_xml', `nginx', or `write_http' plugin.
786 <http://curl.haxx.se/>
789 Used by the `dbi' plugin to connect to various databases.
790 <http://libdbi.sourceforge.net/>
792 * libesmtp (optional)
793 For the `notify_email' plugin.
794 <http://www.stafford.uklinux.net/libesmtp/>
796 * libganglia (optional)
797 Used by the `gmond' plugin to process data received from Ganglia.
798 <http://ganglia.info/>
801 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
805 * libgcrypt (optional)
806 Used by the `network' plugin for encryption and authentication.
807 <http://www.gnupg.org/>
810 Used by the `gps' plugin.
811 <http://developer.berlios.de/projects/gpsd/>
813 * libi2c-dev (optional)
814 Used for the plugin `barometer', provides just the i2c-dev.h header file
815 for user space i2c development.
818 For querying iptables counters.
819 <http://netfilter.org/>
821 * libjevents (optional)
822 The jevents library is used by the `intel_pmu' plugin to access the Linux
823 kernel perf interface.
824 Note: the library should be build with -fPIC flag to be linked with
825 intel_pmu shared object correctly.
826 <https://github.com/andikleen/pmu-tools>
829 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
830 used by the `java' plugin to execute Java bytecode.
831 See docs/BUILD.java.md for detailed build instructions.
832 <http://openjdk.java.net/> (and others)
835 Used by the `openldap' plugin.
836 <http://www.openldap.org/>
839 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
840 <https://www.lua.org/>
843 Used by the `lvm' plugin.
844 <ftp://sources.redhat.com/pub/lvm2/>
846 * libmemcached (optional)
847 Used by the `memcachec' plugin to connect to a memcache daemon.
848 <http://tangent.org/552/libmemcached.html>
850 * libmicrohttpd (optional)
851 Used by the write_prometheus plugin to run an http daemon.
852 <http://www.gnu.org/software/libmicrohttpd/>
855 Used by the `netlink' plugin.
856 <http://www.netfilter.org/projects/libmnl/>
858 * libmodbus (optional)
859 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
860 `modbus' plugin works with version 2.0.3 of the library – due to frequent
861 API changes other versions may or may not compile cleanly.
862 <http://www.libmodbus.org/>
864 * libmysqlclient (optional)
865 Unsurprisingly used by the `mysql' plugin.
866 <http://dev.mysql.com/>
868 * libnetapp (optional)
869 Required for the `netapp' plugin.
870 This library is part of the “Manage ONTAP SDK” published by NetApp.
872 * libnetsnmp (optional)
873 For the `snmp' and 'snmp_agent' plugins.
874 <http://www.net-snmp.org/>
876 * libnetsnmpagent (optional)
877 Required for the 'snmp_agent' plugin.
878 <http://www.net-snmp.org/>
880 * libnotify (optional)
881 For the `notify_desktop' plugin.
882 <http://www.galago-project.org/>
884 * libopenipmi (optional)
885 Used by the `ipmi' plugin to prove IPMI devices.
886 <http://openipmi.sourceforge.net/>
888 * liboping (optional)
889 Used by the `ping' plugin to send and receive ICMP packets.
890 <http://octo.it/liboping/>
892 * libowcapi (optional)
893 Used by the `onewire' plugin to read values from onewire sensors (or the
895 <http://www.owfs.org/>
898 Used to capture packets by the `dns' plugin.
899 <http://www.tcpdump.org/>
901 * libperfstat (optional)
902 Used by various plugins to gather statistics under AIX.
905 Obviously used by the `perl' plugin. The library has to be compiled with
906 ithread support (introduced in Perl 5.6.0).
907 <http://www.perl.org/>
910 The PostgreSQL C client library used by the `postgresql' plugin.
911 <http://www.postgresql.org/>
914 The PQoS library for Intel(R) Resource Director Technology used by the
916 <https://github.com/01org/intel-cmt-cat>
918 * libprotobuf, protoc 3.0+ (optional)
919 Used by the `grpc' plugin to generate service stubs and code to handle
920 network packets of collectd's protobuf-based network protocol.
921 <https://developers.google.com/protocol-buffers/>
923 * libprotobuf-c, protoc-c (optional)
924 Used by the `pinba' plugin to generate a parser for the network packets
925 sent by the Pinba PHP extension.
926 <http://code.google.com/p/protobuf-c/>
928 * libpython (optional)
929 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
931 <http://www.python.org/>
933 * libqpid-proton (optional)
934 Used by the `amqp1' plugin for AMQP 1.0 connections, for example to
936 <http://qpid.apache.org/>
938 * librabbitmq (optional; also called “rabbitmq-c”)
939 Used by the `amqp' plugin for AMQP 0.9.1 connections, for example to
941 <http://hg.rabbitmq.com/rabbitmq-c/>
943 * librdkafka (optional; also called “rdkafka”)
944 Used by the `write_kafka' plugin for producing messages and sending them
946 <https://github.com/edenhill/librdkafka>
948 * librouteros (optional)
949 Used by the `routeros' plugin to connect to a device running `RouterOS'.
950 <http://octo.it/librouteros/>
953 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
954 client support which was added after version 1.3 of RRDtool. Versions 1.0,
955 1.2 and 1.3 are known to work with the `rrdtool' plugin.
956 <http://oss.oetiker.ch/rrdtool/>
958 * librt, libsocket, libkstat, libdevinfo (optional)
959 Various standard Solaris libraries which provide system functions.
960 <http://developers.sun.com/solaris/>
962 * libsensors (optional)
963 To read from `lm_sensors', see the `sensors' plugin.
964 <http://www.lm-sensors.org/>
966 * libsigrok (optional)
967 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
968 libzip, and optionally (depending on which drivers are enabled) on
969 libusb, libftdi and libudev.
971 * libstatgrab (optional)
972 Used by various plugins to collect statistics on systems other than Linux
974 <http://www.i-scream.org/libstatgrab/>
976 * libtokyotyrant (optional)
977 Used by the `tokyotyrant' plugin.
978 <http://1978th.net/tokyotyrant/>
980 * libupsclient/nut (optional)
981 For the `nut' plugin which queries nut's `upsd'.
982 <http://networkupstools.org/>
985 Collect statistics from virtual machines.
986 <http://libvirt.org/>
989 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
991 <http://xmlsoft.org/>
994 Used by the `xencpu' plugin.
995 <http://xenbits.xensource.com/>
998 <http://www.xmms.org/>
1000 * libyajl (optional)
1001 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
1002 'ovs_stats' and `log_logstash' plugins.
1003 <http://github.com/lloyd/yajl>
1005 * libvarnish (optional)
1006 Fetches statistics from a Varnish instance. This is needed for the
1008 <http://varnish-cache.org>
1010 * riemann-c-client (optional)
1011 For the `write_riemann' plugin.
1012 <https://github.com/algernon/riemann-c-client>
1014 Configuring / Compiling / Installing
1015 ------------------------------------
1017 To configure, build and install collectd with the default settings, run
1018 `./configure && make && make install'. For a complete list of configure
1019 options and their description, run `./configure --help'.
1021 By default, the configure script will check for all build dependencies and
1022 disable all plugins whose requirements cannot be fulfilled (any other plugin
1023 will be enabled). To enable a plugin, install missing dependencies (see
1024 section `Prerequisites' above) and rerun `configure'. If you specify the
1025 `--enable-<plugin>' configure option, the script will fail if the depen-
1026 dencies for the specified plugin are not met. In that case you can force the
1027 plugin to be built using the `--enable-<plugin>=force' configure option.
1028 This will most likely fail though unless you're working in a very unusual
1029 setup and you really know what you're doing. If you specify the
1030 `--disable-<plugin>' configure option, the plugin will not be built. If you
1031 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
1032 options, all plugins will be enabled or disabled respectively by default.
1033 Explicitly enabling or disabling a plugin overwrites the default for the
1034 specified plugin. These options are meant for package maintainers and should
1035 not be used in everyday situations.
1037 By default, collectd will be installed into `/opt/collectd'. You can adjust
1038 this setting by specifying the `--prefix' configure option - see INSTALL for
1039 details. If you pass DESTDIR=<path> to `make install', <path> will be
1040 prefixed to all installation directories. This might be useful when creating
1041 packages for collectd.
1043 Generating the configure script
1044 -------------------------------
1046 Collectd ships with a `build.sh' script to generate the `configure'
1047 script shipped with releases.
1049 To generate the `configure` script, you'll need the following dependencies:
1058 The `build.sh' script takes no arguments.
1062 -----------------------------------------------
1064 Collectd can be built on Windows using Cygwin, and the result is a binary that
1065 runs natively on Windows. That is, Cygwin is only needed for building, not running,
1068 You will need to install the following Cygwin packages:
1075 - mingw64-x86_64-dlfcn
1076 - mingw64-x86_64-gcc-core
1077 - mingw64-x86_64-zlib
1080 To build, just run the `build.sh' script in your Cygwin terminal. By default, it installs
1081 to "C:/Program Files/collectd". You can change the location by setting the INSTALL_DIR
1084 $ export INSTALL_DIR="C:/some/other/install/directory"
1089 $ INSTALL_DIR="C:/some/other/install/directory" ./build.sh
1095 To compile correctly collectd needs to be able to initialize static
1096 variables to NAN (Not A Number). Some C libraries, especially the GNU
1097 libc, have a problem with that.
1099 Luckily, with GCC it's possible to work around that problem: One can define
1100 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1101 ``implementation'' the configure script needs to compile and run a short
1102 test program. Obviously running a test program when doing a cross-
1103 compilation is, well, challenging.
1105 If you run into this problem, you can use the `--with-nan-emulation'
1106 configure option to force the use of this implementation. We can't promise
1107 that the compiled binary actually behaves as it should, but since NANs
1108 are likely never passed to the libm you have a good chance to be lucky.
1110 Likewise, collectd needs to know the layout of doubles in memory, in order
1111 to craft uniform network packets over different architectures. For this, it
1112 needs to know how to convert doubles into the memory layout used by x86. The
1113 configure script tries to figure this out by compiling and running a few
1114 small test programs. This is of course not possible when cross-compiling.
1115 You can use the `--with-fp-layout' option to tell the configure script which
1116 conversion method to assume. Valid arguments are:
1118 * `nothing' (12345678 -> 12345678)
1119 * `endianflip' (12345678 -> 87654321)
1120 * `intswap' (12345678 -> 56781234)
1126 Please use GitHub to report bugs and submit pull requests:
1127 <https://github.com/collectd/collectd/>.
1128 See CONTRIBUTING.md for details.
1130 For questions, development information and basically all other concerns please
1131 send an email to collectd's mailing list at
1132 <list at collectd.org>.
1134 For live discussion and more personal contact visit us in IRC, we're in
1135 channel #collectd on freenode.
1141 Florian octo Forster <octo at collectd.org>,
1142 Sebastian tokkee Harl <sh at tokkee.org>,
1143 and many contributors (see `AUTHORS').
projects / collectd.git / blob