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.
106 This plugin should be compiled with compiler defenses enabled, for
107 example -fstack-protector.
110 Collect individual drbd resource statistics.
113 Email statistics: Count, traffic, spam scores and checks.
114 See collectd-email(5).
117 Amount of entropy available to the system.
120 Network interface card statistics.
123 Values gathered by a custom program or script.
124 See collectd-exec(5).
127 File handles statistics.
130 Count the number of files in directories.
133 Linux file-system based caching framework statistics.
136 Receive multicast traffic from Ganglia instances.
139 Monitor gps related data through gpsd.
142 Monitor NVIDIA GPU statistics available through NVML.
145 Hard disk temperatures using hddtempd.
148 Report the number of used and free hugepages. More info on
149 hugepages can be found here:
150 https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt.
152 This plugin should be compiled with compiler defenses enabled, for
153 example -fstack-protector.
156 The intel_pmu plugin reads performance counters provided by the Linux
157 kernel perf interface. The plugin uses jevents library to resolve named
158 events to perf events and access perf interface.
161 The intel_rdt plugin collects information provided by monitoring features
162 of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
163 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features
164 provide information about utilization of shared resources like last level
165 cache occupancy, local memory bandwidth usage, remote memory bandwidth
166 usage, instructions per clock.
167 <https://01.org/packet-processing/cache-monitoring-technology-memory-bandwidth-monitoring-cache-allocation-technology-code-and-data>
170 Interface traffic: Number of octets, packets and errors for each
174 IPC counters: semaphores used, number of allocated segments in shared
178 IPMI (Intelligent Platform Management Interface) sensors information.
181 Iptables' counters: Number of bytes that were matched by a certain
185 IPVS connection statistics (number of connections, octets and packets
186 for each service and destination).
187 See http://www.linuxvirtualserver.org/software/index.html.
190 IRQ counters: Frequency in which certain interrupts occur.
193 Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
195 See docs/BUILD.java.md for detailed build instructions.
198 System load average over the last 1, 5 and 15 minutes.
201 Detailed CPU statistics of the “Logical Partitions” virtualization
202 technique built into IBM's POWER processors.
205 The Lua plugin implements a Lua interpreter into collectd. This
206 makes it possible to write plugins in Lua which are executed by
207 collectd without the need to start a heavy interpreter every interval.
208 See collectd-lua(5) for details.
211 Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
212 “Logical Volume Manager” (LVM).
215 Queries very detailed usage statistics from wireless LAN adapters and
216 interfaces that use the Atheros chipset and the MadWifi driver.
219 Motherboard sensors: temperature, fan speed and voltage information,
223 Monitor machine check exceptions (hardware errors detected by hardware
224 and reported to software) reported by mcelog and generate appropriate
225 notifications when machine check exceptions are detected.
228 Linux software-RAID device information (number of active, failed, spare
232 Query and parse data from a memcache daemon (memcached).
235 Statistics of the memcached distributed caching system.
236 <http://www.danga.com/memcached/>
239 Memory utilization: Memory occupied by running processes, page cache,
240 buffer cache and free.
243 Collects CPU usage, memory usage, temperatures and power consumption from
244 Intel Many Integrated Core (MIC) CPUs.
247 Reads values from Modbus/TCP enabled devices. Supports reading values
248 from multiple "slaves" so gateway devices can be used.
251 Information provided by serial multimeters, such as the `Metex
255 MySQL server statistics: Commands issued, handlers triggered, thread
256 usage, query cache utilization and traffic/octets sent and received.
259 Plugin to query performance values from a NetApp storage system using the
260 “Manage ONTAP” SDK provided by NetApp.
263 Very detailed Linux network interface and routing statistics. You can get
264 (detailed) information on interfaces, qdiscs, classes, and, if you can
265 make use of it, filters.
268 Receive values that were collected by other hosts. Large setups will
269 want to collect the data on one dedicated machine, and this is the
270 plugin of choice for that.
273 NFS Procedures: Which NFS command were called how often.
276 Collects statistics from `nginx' (speak: engine X), a HTTP and mail
280 NTP daemon statistics: Local clock drift, offset to peers, etc.
283 Information about Non-Uniform Memory Access (NUMA).
286 Network UPS tools: UPS current, voltage, power, charge, utilisation,
287 temperature, etc. See upsd(8).
290 Queries routing information from the “Optimized Link State Routing”
293 - onewire (EXPERIMENTAL!)
294 Read onewire sensors using the owcapu library of the owfs project.
295 Please read in collectd.conf(5) why this plugin is experimental.
298 Read monitoring information from OpenLDAP's cn=Monitor subtree.
301 RX and TX of each client in openvpn-status.log (status-version 2).
302 <http://openvpn.net/index.php/documentation/howto.html>
305 Query data from an Oracle database.
308 The plugin monitors the link status of Open vSwitch (OVS) connected
309 interfaces, dispatches the values to collectd and sends the notification
310 whenever the link state change occurs in the OVS database. It requires
311 YAJL library to be installed.
312 Detailed instructions for installing and setting up Open vSwitch, see
314 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
317 The plugin collects the statistics of OVS connected bridges and
318 interfaces. It requires YAJL library to be installed.
319 Detailed instructions for installing and setting up Open vSwitch, see
321 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
324 Read errors from PCI Express Device Status and AER extended capabilities.
325 <https://www.design-reuse.com/articles/38374/pcie-error-logging-and-handling-on-a-typical-soc.html>
328 The perl plugin implements a Perl-interpreter into collectd. You can
329 write your own plugins in Perl and return arbitrary values using this
330 API. See collectd-perl(5).
333 Query statistics from BSD's packet filter "pf".
336 Receive and dispatch timing values from Pinba, a profiling extension for
340 Network latency: Time to reach the default gateway or another given
344 PostgreSQL database statistics: active server connections, transaction
345 numbers, block IO, table row manipulations.
348 PowerDNS name server statistics.
351 Process counts: Number of running, sleeping, zombie, ... processes.
354 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
357 The python plugin implements a Python interpreter into collectd. This
358 makes it possible to write plugins in Python which are executed by
359 collectd without the need to start a heavy interpreter every interval.
360 See collectd-python(5) for details.
363 The redis plugin gathers information from a Redis server, including:
364 uptime, used memory, total connections etc.
367 Query interface and wireless registration statistics from RouterOS.
370 RRDtool caching daemon (RRDcacheD) statistics.
373 System sensors, accessed using lm_sensors: Voltages, temperatures and
377 RX and TX of serial interfaces. Linux only; needs root privileges.
380 Uses libsigrok as a backend, allowing any sigrok-supported device
381 to have its measurements fed to collectd. This includes multimeters,
382 sound level meters, thermometers, and much more.
385 Collect SMART statistics, notably load cycle count, temperature
389 Read values from SNMP (Simple Network Management Protocol) enabled
390 network devices such as switches, routers, thermometers, rack monitoring
391 servers, etc. See collectd-snmp(5).
394 Acts as a StatsD server, reading values sent over the network from StatsD
395 clients and calculating rates and other aggregates out of these values.
398 Listens to rsyslog events and submits matched values.
401 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
404 Parse table-like structured files.
407 Follows (tails) log files, parses them by lines and submits matched
411 Follows (tails) files in CSV format, parses each line and submits
415 Bytes and operations read and written on tape devices. Solaris only.
418 Number of TCP connections to specific local and remote ports.
421 TeamSpeak2 server statistics.
424 Plugin to read values from `The Energy Detective' (TED).
427 Linux ACPI thermal zone information.
430 Reads the number of records and file size from a running Tokyo Tyrant
434 Reads CPU frequency and C-state residency on modern Intel
435 turbo-capable processors.
438 System uptime statistics.
441 Users currently logged in.
444 Various statistics from Varnish, an HTTP accelerator.
447 CPU, memory, disk and network I/O statistics from virtual machines.
450 Virtual memory statistics, e.g. the number of page-ins/-outs or the
451 number of pagefaults.
454 System resources used by Linux VServers.
455 See <http://linux-vserver.org/>.
458 Link quality of wireless cards. Linux only.
461 XEN Hypervisor CPU stats.
464 Bitrate and frequency of music played with XMMS.
467 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
470 Measures the percentage of cpu load per container (zone) under Solaris 10
474 Read data from Zookeeper's MNTR command.
476 * Output can be written or sent to various destinations by the following
480 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
481 0.9.1 server, such as RabbitMQ.
484 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
485 1.0 server, such as Qpid Dispatch Router or Apache Artemis Broker.
488 Write to comma separated values (CSV) files. This needs lots of
489 diskspace but is extremely portable and can be analysed with almost
490 every program that can analyse anything. Even Microsoft's Excel..
493 Send and receive values over the network using the gRPC framework.
496 It's possible to implement write plugins in Lua using the Lua
497 plugin. See collectd-lua(5) for details.
500 Publishes and subscribes to MQTT topics.
503 Send the data to a remote host to save the data somehow. This is useful
504 for large setups where the data should be saved by a dedicated machine.
507 Of course the values are propagated to plugins written in Perl, too, so
508 you can easily do weird stuff with the plugins we didn't dare think of
509 ;) See collectd-perl(5).
512 It's possible to implement write plugins in Python using the python
513 plugin. See collectd-python(5) for details.
516 Output to round-robin-database (RRD) files using the RRDtool caching
517 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
518 implementation of the caching done by the `rrdtool' plugin.
521 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
522 This is likely the most popular destination for such values. Since
523 updates to RRD-files are somewhat expensive this plugin can cache
524 updates to the files and write a bunch of updates at once, which lessens
528 Receives and handles queries from SNMP master agent and returns the data
529 collected by read plugins. Handles requests only for OIDs specified in
530 configuration file. To handle SNMP queries the plugin gets data from
531 collectd and translates requested values from collectd's internal format
535 One can query the values from the unixsock plugin whenever they're
536 needed. Please read collectd-unixsock(5) for a description on how that's
540 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
541 can be configured to avoid logging send errors (especially useful when
545 Sends the values collected by collectd to a web-server using HTTP POST
546 requests. The transmitted data is either in a form understood by the
547 Exec plugin or formatted in JSON.
550 Sends data to Apache Kafka, a distributed queue.
553 Writes data to the log
556 Sends data to MongoDB, a NoSQL database.
559 Publish values using an embedded HTTP server, in a format compatible
560 with Prometheus' collectd_exporter.
563 Sends the values to a Redis key-value database server.
566 Sends data to Riemann, a stream processing and monitoring system.
569 Sends data to Sensu, a stream processing and monitoring system, via the
570 Sensu client local TCP socket.
573 Sends data in syslog format, using TCP, where the message
574 contains the metric in human or JSON format.
577 Sends data OpenTSDB, a scalable no master, no shared state time series
580 * Logging is, as everything in collectd, provided by plugins. The following
581 plugins keep us informed about what's going on:
584 Writes log messages to a file or STDOUT/STDERR.
587 Log messages are propagated to plugins written in Perl as well.
588 See collectd-perl(5).
591 It's possible to implement log plugins in Python using the python plugin.
592 See collectd-python(5) for details.
595 Logs to the standard UNIX logging mechanism, syslog.
598 Writes log messages formatted as logstash JSON events.
600 * Notifications can be handled by the following plugins:
603 Send a desktop notification to a notification daemon, as defined in
604 the Desktop Notification Specification. To actually display the
605 notifications, notification-daemon is required.
606 See http://www.galago-project.org/specs/notification/.
609 Send an E-mail with the notification message to the configured
613 Submit notifications as passive check results to a local nagios instance.
616 Execute a program or script to handle the notification.
617 See collectd-exec(5).
620 Writes the notification message to a file or STDOUT/STDERR.
623 Send the notification to a remote host to handle it somehow.
626 Notifications are propagated to plugins written in Perl as well.
627 See collectd-perl(5).
630 It's possible to implement notification plugins in Python using the
631 python plugin. See collectd-python(5) for details.
633 * Value processing can be controlled using the "filter chain" infrastructure
634 and "matches" and "targets". The following plugins are available:
636 - match_empty_counter
637 Match counter values which are currently zero.
640 Match values using a hash function of the hostname.
643 Match values by their identifier based on regular expressions.
646 Match values with an invalid timestamp.
649 Select values by their data sources' values.
651 - target_notification
652 Create and dispatch a notification.
655 Replace parts of an identifier using regular expressions.
658 Scale (multiply) values by an arbitrary value.
661 Set (overwrite) entire parts of an identifier.
663 * Miscellaneous plugins:
666 Selects multiple value lists based on patterns or regular expressions
667 and creates new aggregated values lists from those.
670 Checks values against configured thresholds and creates notifications if
671 values are out of bounds. See collectd-threshold(5) for details.
674 Sets the hostname to a unique identifier. This is meant for setups
675 where each client may migrate to another physical host, possibly going
676 through one or more name changes in the process.
678 * Performance: Since collectd is running as a daemon it doesn't spend much
679 time starting up again and again. With the exception of the exec plugin no
680 processes are forked. Caching in output plugins, such as the rrdtool and
681 network plugins, makes sure your resources are used efficiently. Also,
682 since collectd is programmed multithreaded it benefits from hyper-threading
683 and multicore processors and makes sure that the daemon isn't idle if only
684 one plugin waits for an IO-operation to complete.
686 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
687 as possible and the default values should be okay for most users.
693 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
694 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
695 for a list of options and a syntax description.
697 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
698 files. The usual place for these files is beneath `/var/lib/collectd'.
700 * When using some of the plugins, collectd needs to run as user root, since
701 only root can do certain things, such as craft ICMP packages needed to ping
702 other hosts. collectd should NOT be installed setuid root since it can be
703 used to overwrite valuable files!
705 * Sample scripts to generate graphs reside in `contrib/' in the source
706 package or somewhere near `/usr/share/doc/collectd' in most distributions.
707 Please be aware that those script are meant as a starting point for your
708 own experiments.. Some of them require the `RRDs' Perl module.
709 (`librrds-perl' on Debian) If you have written a more sophisticated
710 solution please share it with us.
712 * The RRAs of the automatically created RRD files depend on the `step'
713 and `heartbeat' settings given. If change these settings you may need to
714 re-create the files, losing all data. Please be aware of that when changing
715 the values and read the rrdtool(1) manpage thoroughly.
718 collectd and chkrootkit
719 -----------------------
721 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
722 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
723 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
724 this case, collectd is a legitimate sniffer and the report should be
725 considered to be a false positive. However, you might want to check that
726 this really is collectd and not some other, illegitimate sniffer.
732 To compile collectd from source you will need:
734 * Usual suspects: C compiler, linker, preprocessor, make, ...
736 collectd makes use of some common C99 features, e.g. compound literals and
737 mixed declarations, and therefore requires a C99 compatible compiler.
739 On Debian and Ubuntu, the "build-essential" package should pull in
740 everything that's necessary.
742 * A POSIX-threads (pthread) implementation.
743 Since gathering some statistics is slow (network connections, slow devices,
744 etc) collectd is parallelized. The POSIX threads interface is being
745 used and should be found in various implementations for hopefully all
748 * When building from the Git repository, flex (tokenizer) and bison (parser
749 generator) are required. Release tarballs include the generated files – you
750 don't need these packages in that case.
752 * aerotools-ng (optional)
753 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
754 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
755 nor does it feature an installation routine. Therefore, you need to point
756 collectd's configure script at the source directory of the `aerotools-ng'
758 <https://github.com/lynix/aerotools-ng>
760 * CoreFoundation.framework and IOKit.framework (optional)
761 For compiling on Darwin in general and the `apple_sensors' plugin in
763 <http://developer.apple.com/corefoundation/>
766 Used by the `gpu_nvidia' plugin
767 <https://developer.nvidia.com/cuda-downloads>
769 * libatasmart (optional)
770 Used by the `smart' plugin.
771 <http://git.0pointer.de/?p=libatasmart.git>
774 The `turbostat' plugin can optionally build Linux Capabilities support,
775 which avoids full privileges requirement (aka. running as root) to read
777 <http://sites.google.com/site/fullycapable/>
779 * libclntsh (optional)
780 Used by the `oracle' plugin.
782 * libhiredis (optional)
783 Used by the redis plugin. Please note that you require a 0.10.0 version
784 or higher. <https://github.com/redis/hiredis>
787 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
788 `curl_xml', `nginx', or `write_http' plugin.
789 <http://curl.haxx.se/>
792 Used by the `dbi' plugin to connect to various databases.
793 <http://libdbi.sourceforge.net/>
795 * libesmtp (optional)
796 For the `notify_email' plugin.
797 <http://www.stafford.uklinux.net/libesmtp/>
799 * libganglia (optional)
800 Used by the `gmond' plugin to process data received from Ganglia.
801 <http://ganglia.info/>
804 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
808 * libgcrypt (optional)
809 Used by the `network' plugin for encryption and authentication.
810 <http://www.gnupg.org/>
813 Used by the `gps' plugin.
814 <http://developer.berlios.de/projects/gpsd/>
816 * libi2c-dev (optional)
817 Used for the plugin `barometer', provides just the i2c-dev.h header file
818 for user space i2c development.
821 For querying iptables counters.
822 <http://netfilter.org/>
824 * libjevents (optional)
825 The jevents library is used by the `intel_pmu' plugin to access the Linux
826 kernel perf interface.
827 Note: the library should be build with -fPIC flag to be linked with
828 intel_pmu shared object correctly.
829 <https://github.com/andikleen/pmu-tools>
832 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
833 used by the `java' plugin to execute Java bytecode.
834 See docs/BUILD.java.md for detailed build instructions.
835 <http://openjdk.java.net/> (and others)
838 Used by the `openldap' plugin.
839 <http://www.openldap.org/>
842 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
843 <https://www.lua.org/>
846 Used by the `lvm' plugin.
847 <ftp://sources.redhat.com/pub/lvm2/>
849 * libmemcached (optional)
850 Used by the `memcachec' plugin to connect to a memcache daemon.
851 <http://tangent.org/552/libmemcached.html>
853 * libmicrohttpd (optional)
854 Used by the write_prometheus plugin to run an http daemon.
855 <http://www.gnu.org/software/libmicrohttpd/>
858 Used by the `netlink' plugin.
859 <http://www.netfilter.org/projects/libmnl/>
861 * libmodbus (optional)
862 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
863 `modbus' plugin works with version 2.0.3 of the library – due to frequent
864 API changes other versions may or may not compile cleanly.
865 <http://www.libmodbus.org/>
867 * libmysqlclient (optional)
868 Unsurprisingly used by the `mysql' plugin.
869 <http://dev.mysql.com/>
871 * libnetapp (optional)
872 Required for the `netapp' plugin.
873 This library is part of the “Manage ONTAP SDK” published by NetApp.
875 * libnetsnmp (optional)
876 For the `snmp' and 'snmp_agent' plugins.
877 <http://www.net-snmp.org/>
879 * libnetsnmpagent (optional)
880 Required for the 'snmp_agent' plugin.
881 <http://www.net-snmp.org/>
883 * libnotify (optional)
884 For the `notify_desktop' plugin.
885 <http://www.galago-project.org/>
887 * libopenipmi (optional)
888 Used by the `ipmi' plugin to prove IPMI devices.
889 <http://openipmi.sourceforge.net/>
891 * liboping (optional)
892 Used by the `ping' plugin to send and receive ICMP packets.
893 <http://octo.it/liboping/>
895 * libowcapi (optional)
896 Used by the `onewire' plugin to read values from onewire sensors (or the
898 <http://www.owfs.org/>
901 Used to capture packets by the `dns' plugin.
902 <http://www.tcpdump.org/>
904 * libperfstat (optional)
905 Used by various plugins to gather statistics under AIX.
908 Obviously used by the `perl' plugin. The library has to be compiled with
909 ithread support (introduced in Perl 5.6.0).
910 <http://www.perl.org/>
913 The PostgreSQL C client library used by the `postgresql' plugin.
914 <http://www.postgresql.org/>
917 The PQoS library for Intel(R) Resource Director Technology used by the
919 <https://github.com/01org/intel-cmt-cat>
921 * libprotobuf, protoc 3.0+ (optional)
922 Used by the `grpc' plugin to generate service stubs and code to handle
923 network packets of collectd's protobuf-based network protocol.
924 <https://developers.google.com/protocol-buffers/>
926 * libprotobuf-c, protoc-c (optional)
927 Used by the `pinba' plugin to generate a parser for the network packets
928 sent by the Pinba PHP extension.
929 <http://code.google.com/p/protobuf-c/>
931 * libpython (optional)
932 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
934 <http://www.python.org/>
936 * libqpid-proton (optional)
937 Used by the `amqp1' plugin for AMQP 1.0 connections, for example to
939 <http://qpid.apache.org/>
941 * librabbitmq (optional; also called “rabbitmq-c”)
942 Used by the `amqp' plugin for AMQP 0.9.1 connections, for example to
944 <http://hg.rabbitmq.com/rabbitmq-c/>
946 * librdkafka (optional; also called “rdkafka”)
947 Used by the `write_kafka' plugin for producing messages and sending them
949 <https://github.com/edenhill/librdkafka>
951 * librouteros (optional)
952 Used by the `routeros' plugin to connect to a device running `RouterOS'.
953 <http://octo.it/librouteros/>
956 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
957 client support which was added after version 1.3 of RRDtool. Versions 1.0,
958 1.2 and 1.3 are known to work with the `rrdtool' plugin.
959 <http://oss.oetiker.ch/rrdtool/>
961 * librt, libsocket, libkstat, libdevinfo (optional)
962 Various standard Solaris libraries which provide system functions.
963 <http://developers.sun.com/solaris/>
965 * libsensors (optional)
966 To read from `lm_sensors', see the `sensors' plugin.
967 <http://www.lm-sensors.org/>
969 * libsigrok (optional)
970 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
971 libzip, and optionally (depending on which drivers are enabled) on
972 libusb, libftdi and libudev.
974 * libstatgrab (optional)
975 Used by various plugins to collect statistics on systems other than Linux
977 <http://www.i-scream.org/libstatgrab/>
979 * libtokyotyrant (optional)
980 Used by the `tokyotyrant' plugin.
981 <http://1978th.net/tokyotyrant/>
983 * libupsclient/nut (optional)
984 For the `nut' plugin which queries nut's `upsd'.
985 <http://networkupstools.org/>
988 Collect statistics from virtual machines.
989 <http://libvirt.org/>
992 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
994 <http://xmlsoft.org/>
997 Used by the `xencpu' plugin.
998 <http://xenbits.xensource.com/>
1000 * libxmms (optional)
1001 <http://www.xmms.org/>
1003 * libyajl (optional)
1004 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
1005 'ovs_stats' and `log_logstash' plugins.
1006 <http://github.com/lloyd/yajl>
1008 * libvarnish (optional)
1009 Fetches statistics from a Varnish instance. This is needed for the
1011 <http://varnish-cache.org>
1013 * riemann-c-client (optional)
1014 For the `write_riemann' plugin.
1015 <https://github.com/algernon/riemann-c-client>
1017 Configuring / Compiling / Installing
1018 ------------------------------------
1020 To configure, build and install collectd with the default settings, run
1021 `./configure && make && make install'. For a complete list of configure
1022 options and their description, run `./configure --help'.
1024 By default, the configure script will check for all build dependencies and
1025 disable all plugins whose requirements cannot be fulfilled (any other plugin
1026 will be enabled). To enable a plugin, install missing dependencies (see
1027 section `Prerequisites' above) and rerun `configure'. If you specify the
1028 `--enable-<plugin>' configure option, the script will fail if the depen-
1029 dencies for the specified plugin are not met. In that case you can force the
1030 plugin to be built using the `--enable-<plugin>=force' configure option.
1031 This will most likely fail though unless you're working in a very unusual
1032 setup and you really know what you're doing. If you specify the
1033 `--disable-<plugin>' configure option, the plugin will not be built. If you
1034 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
1035 options, all plugins will be enabled or disabled respectively by default.
1036 Explicitly enabling or disabling a plugin overwrites the default for the
1037 specified plugin. These options are meant for package maintainers and should
1038 not be used in everyday situations.
1040 By default, collectd will be installed into `/opt/collectd'. You can adjust
1041 this setting by specifying the `--prefix' configure option - see INSTALL for
1042 details. If you pass DESTDIR=<path> to `make install', <path> will be
1043 prefixed to all installation directories. This might be useful when creating
1044 packages for collectd.
1046 Generating the configure script
1047 -------------------------------
1049 Collectd ships with a `build.sh' script to generate the `configure'
1050 script shipped with releases.
1052 To generate the `configure` script, you'll need the following dependencies:
1061 The `build.sh' script takes no arguments.
1065 -----------------------------------------------
1067 Collectd can be built on Windows using Cygwin, and the result is a binary that
1068 runs natively on Windows. That is, Cygwin is only needed for building, not running,
1071 You will need to install the following Cygwin packages:
1078 - mingw64-x86_64-dlfcn
1079 - mingw64-x86_64-gcc-core
1080 - mingw64-x86_64-zlib
1083 To build, just run the `build.sh' script in your Cygwin terminal. By default, it installs
1084 to "C:/Program Files/collectd". You can change the location by setting the INSTALL_DIR
1087 $ export INSTALL_DIR="C:/some/other/install/directory"
1092 $ INSTALL_DIR="C:/some/other/install/directory" ./build.sh
1098 To compile correctly collectd needs to be able to initialize static
1099 variables to NAN (Not A Number). Some C libraries, especially the GNU
1100 libc, have a problem with that.
1102 Luckily, with GCC it's possible to work around that problem: One can define
1103 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1104 ``implementation'' the configure script needs to compile and run a short
1105 test program. Obviously running a test program when doing a cross-
1106 compilation is, well, challenging.
1108 If you run into this problem, you can use the `--with-nan-emulation'
1109 configure option to force the use of this implementation. We can't promise
1110 that the compiled binary actually behaves as it should, but since NANs
1111 are likely never passed to the libm you have a good chance to be lucky.
1113 Likewise, collectd needs to know the layout of doubles in memory, in order
1114 to craft uniform network packets over different architectures. For this, it
1115 needs to know how to convert doubles into the memory layout used by x86. The
1116 configure script tries to figure this out by compiling and running a few
1117 small test programs. This is of course not possible when cross-compiling.
1118 You can use the `--with-fp-layout' option to tell the configure script which
1119 conversion method to assume. Valid arguments are:
1121 * `nothing' (12345678 -> 12345678)
1122 * `endianflip' (12345678 -> 87654321)
1123 * `intswap' (12345678 -> 56781234)
1129 Please use GitHub to report bugs and submit pull requests:
1130 <https://github.com/collectd/collectd/>.
1131 See CONTRIBUTING.md for details.
1133 For questions, development information and basically all other concerns please
1134 send an email to collectd's mailing list at
1135 <list at collectd.org>.
1137 For live discussion and more personal contact visit us in IRC, we're in
1138 channel #collectd on freenode.
1144 Florian octo Forster <octo at collectd.org>,
1145 Sebastian tokkee Harl <sh at tokkee.org>,
1146 and many contributors (see `AUTHORS').
projects / collectd.git / blob