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 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.
146 This plugin should be compiled with compiler defenses enabled, for
147 example -fstack-protector.
150 The intel_pmu plugin reads performance counters provided by the Linux
151 kernel perf interface. The plugin uses jevents library to resolve named
152 events to perf events and access perf interface.
155 The intel_rdt plugin collects information provided by monitoring features
156 of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
157 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features
158 provide information about utilization of shared resources like last level
159 cache occupancy, local memory bandwidth usage, remote memory bandwidth
160 usage, instructions per clock.
161 <https://01.org/packet-processing/cache-monitoring-technology-memory-bandwidth-monitoring-cache-allocation-technology-code-and-data>
164 Interface traffic: Number of octets, packets and errors for each
168 IPC counters: semaphores used, number of allocated segments in shared
172 IPMI (Intelligent Platform Management Interface) sensors information.
175 Iptables' counters: Number of bytes that were matched by a certain
179 IPVS connection statistics (number of connections, octets and packets
180 for each service and destination).
181 See http://www.linuxvirtualserver.org/software/index.html.
184 IRQ counters: Frequency in which certain interrupts occur.
187 Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
189 See docs/BUILD.java.md for detailed build instructions.
192 System load average over the last 1, 5 and 15 minutes.
195 Detailed CPU statistics of the “Logical Partitions” virtualization
196 technique built into IBM's POWER processors.
199 The Lua plugin implements a Lua interpreter into collectd. This
200 makes it possible to write plugins in Lua which are executed by
201 collectd without the need to start a heavy interpreter every interval.
202 See collectd-lua(5) for details.
205 Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
206 “Logical Volume Manager” (LVM).
209 Queries very detailed usage statistics from wireless LAN adapters and
210 interfaces that use the Atheros chipset and the MadWifi driver.
213 Motherboard sensors: temperature, fan speed and voltage information,
217 Monitor machine check exceptions (hardware errors detected by hardware
218 and reported to software) reported by mcelog and generate appropriate
219 notifications when machine check exceptions are detected.
222 Linux software-RAID device information (number of active, failed, spare
226 Query and parse data from a memcache daemon (memcached).
229 Statistics of the memcached distributed caching system.
230 <http://www.danga.com/memcached/>
233 Memory utilization: Memory occupied by running processes, page cache,
234 buffer cache and free.
237 Collects CPU usage, memory usage, temperatures and power consumption from
238 Intel Many Integrated Core (MIC) CPUs.
241 Reads values from Modbus/TCP enabled devices. Supports reading values
242 from multiple "slaves" so gateway devices can be used.
245 Information provided by serial multimeters, such as the `Metex
249 MySQL server statistics: Commands issued, handlers triggered, thread
250 usage, query cache utilization and traffic/octets sent and received.
253 Plugin to query performance values from a NetApp storage system using the
254 “Manage ONTAP” SDK provided by NetApp.
257 Very detailed Linux network interface and routing statistics. You can get
258 (detailed) information on interfaces, qdiscs, classes, and, if you can
259 make use of it, filters.
262 Receive values that were collected by other hosts. Large setups will
263 want to collect the data on one dedicated machine, and this is the
264 plugin of choice for that.
267 NFS Procedures: Which NFS command were called how often.
270 Collects statistics from `nginx' (speak: engine X), a HTTP and mail
274 NTP daemon statistics: Local clock drift, offset to peers, etc.
277 Information about Non-Uniform Memory Access (NUMA).
280 Network UPS tools: UPS current, voltage, power, charge, utilisation,
281 temperature, etc. See upsd(8).
284 Queries routing information from the “Optimized Link State Routing”
287 - onewire (EXPERIMENTAL!)
288 Read onewire sensors using the owcapu library of the owfs project.
289 Please read in collectd.conf(5) why this plugin is experimental.
292 Read monitoring information from OpenLDAP's cn=Monitor subtree.
295 RX and TX of each client in openvpn-status.log (status-version 2).
296 <http://openvpn.net/index.php/documentation/howto.html>
299 Query data from an Oracle database.
302 The plugin monitors the link status of Open vSwitch (OVS) connected
303 interfaces, dispatches the values to collectd and sends the notification
304 whenever the link state change occurs in the OVS database. It requires
305 YAJL library to be installed.
306 Detailed instructions for installing and setting up Open vSwitch, see
308 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
311 The plugin collects the statistics of OVS connected bridges and
312 interfaces. It requires YAJL library to be installed.
313 Detailed instructions for installing and setting up Open vSwitch, see
315 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
318 The perl plugin implements a Perl-interpreter into collectd. You can
319 write your own plugins in Perl and return arbitrary values using this
320 API. See collectd-perl(5).
323 Query statistics from BSD's packet filter "pf".
326 Receive and dispatch timing values from Pinba, a profiling extension for
330 Network latency: Time to reach the default gateway or another given
334 PostgreSQL database statistics: active server connections, transaction
335 numbers, block IO, table row manipulations.
338 PowerDNS name server statistics.
341 Process counts: Number of running, sleeping, zombie, ... processes.
344 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
347 The python plugin implements a Python interpreter into collectd. This
348 makes it possible to write plugins in Python which are executed by
349 collectd without the need to start a heavy interpreter every interval.
350 See collectd-python(5) for details.
353 The redis plugin gathers information from a Redis server, including:
354 uptime, used memory, total connections etc.
357 Query interface and wireless registration statistics from RouterOS.
360 RRDtool caching daemon (RRDcacheD) statistics.
363 System sensors, accessed using lm_sensors: Voltages, temperatures and
367 RX and TX of serial interfaces. Linux only; needs root privileges.
370 Uses libsigrok as a backend, allowing any sigrok-supported device
371 to have its measurements fed to collectd. This includes multimeters,
372 sound level meters, thermometers, and much more.
375 Collect SMART statistics, notably load cycle count, temperature
379 Read values from SNMP (Simple Network Management Protocol) enabled
380 network devices such as switches, routers, thermometers, rack monitoring
381 servers, etc. See collectd-snmp(5).
384 Acts as a StatsD server, reading values sent over the network from StatsD
385 clients and calculating rates and other aggregates out of these values.
388 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
391 Parse table-like structured files.
394 Follows (tails) log files, parses them by lines and submits matched
398 Follows (tails) files in CSV format, parses each line and submits
402 Bytes and operations read and written on tape devices. Solaris only.
405 Number of TCP connections to specific local and remote ports.
408 TeamSpeak2 server statistics.
411 Plugin to read values from `The Energy Detective' (TED).
414 Linux ACPI thermal zone information.
417 Reads the number of records and file size from a running Tokyo Tyrant
421 Reads CPU frequency and C-state residency on modern Intel
422 turbo-capable processors.
425 System uptime statistics.
428 Users currently logged in.
431 Various statistics from Varnish, an HTTP accelerator.
434 CPU, memory, disk and network I/O statistics from virtual machines.
437 Virtual memory statistics, e.g. the number of page-ins/-outs or the
438 number of pagefaults.
441 System resources used by Linux VServers.
442 See <http://linux-vserver.org/>.
445 Link quality of wireless cards. Linux only.
448 XEN Hypervisor CPU stats.
451 Bitrate and frequency of music played with XMMS.
454 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
457 Measures the percentage of cpu load per container (zone) under Solaris 10
461 Read data from Zookeeper's MNTR command.
463 * Output can be written or sent to various destinations by the following
467 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
468 server, such as RabbitMQ.
471 Write to comma separated values (CSV) files. This needs lots of
472 diskspace but is extremely portable and can be analysed with almost
473 every program that can analyse anything. Even Microsoft's Excel..
476 Send and receive values over the network using the gRPC framework.
479 It's possible to implement write plugins in Lua using the Lua
480 plugin. See collectd-lua(5) for details.
483 Publishes and subscribes to MQTT topics.
486 Send the data to a remote host to save the data somehow. This is useful
487 for large setups where the data should be saved by a dedicated machine.
490 Of course the values are propagated to plugins written in Perl, too, so
491 you can easily do weird stuff with the plugins we didn't dare think of
492 ;) See collectd-perl(5).
495 It's possible to implement write plugins in Python using the python
496 plugin. See collectd-python(5) for details.
499 Output to round-robin-database (RRD) files using the RRDtool caching
500 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
501 implementation of the caching done by the `rrdtool' plugin.
504 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
505 This is likely the most popular destination for such values. Since
506 updates to RRD-files are somewhat expensive this plugin can cache
507 updates to the files and write a bunch of updates at once, which lessens
511 Receives and handles queries from SNMP master agent and returns the data
512 collected by read plugins. Handles requests only for OIDs specified in
513 configuration file. To handle SNMP queries the plugin gets data from
514 collectd and translates requested values from collectd's internal format
518 One can query the values from the unixsock plugin whenever they're
519 needed. Please read collectd-unixsock(5) for a description on how that's
523 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
524 can be configured to avoid logging send errors (especially useful when
528 Sends the values collected by collectd to a web-server using HTTP POST
529 requests. The transmitted data is either in a form understood by the
530 Exec plugin or formatted in JSON.
533 Sends data to Apache Kafka, a distributed queue.
536 Writes data to the log
539 Sends data to MongoDB, a NoSQL database.
542 Publish values using an embedded HTTP server, in a format compatible
543 with Prometheus' collectd_exporter.
546 Sends the values to a Redis key-value database server.
549 Sends data to Riemann, a stream processing and monitoring system.
552 Sends data to Sensu, a stream processing and monitoring system, via the
553 Sensu client local TCP socket.
556 Sends data OpenTSDB, a scalable no master, no shared state time series
559 * Logging is, as everything in collectd, provided by plugins. The following
560 plugins keep us informed about what's going on:
563 Writes log messages to a file or STDOUT/STDERR.
566 Log messages are propagated to plugins written in Perl as well.
567 See collectd-perl(5).
570 It's possible to implement log plugins in Python using the python plugin.
571 See collectd-python(5) for details.
574 Logs to the standard UNIX logging mechanism, syslog.
577 Writes log messages formatted as logstash JSON events.
579 * Notifications can be handled by the following plugins:
582 Send a desktop notification to a notification daemon, as defined in
583 the Desktop Notification Specification. To actually display the
584 notifications, notification-daemon is required.
585 See http://www.galago-project.org/specs/notification/.
588 Send an E-mail with the notification message to the configured
592 Submit notifications as passive check results to a local nagios instance.
595 Execute a program or script to handle the notification.
596 See collectd-exec(5).
599 Writes the notification message to a file or STDOUT/STDERR.
602 Send the notification to a remote host to handle it somehow.
605 Notifications are propagated to plugins written in Perl as well.
606 See collectd-perl(5).
609 It's possible to implement notification plugins in Python using the
610 python plugin. See collectd-python(5) for details.
612 * Value processing can be controlled using the "filter chain" infrastructure
613 and "matches" and "targets". The following plugins are available:
615 - match_empty_counter
616 Match counter values which are currently zero.
619 Match values using a hash function of the hostname.
622 Match values by their identifier based on regular expressions.
625 Match values with an invalid timestamp.
628 Select values by their data sources' values.
630 - target_notification
631 Create and dispatch a notification.
634 Replace parts of an identifier using regular expressions.
637 Scale (multiply) values by an arbitrary value.
640 Set (overwrite) entire parts of an identifier.
642 * Miscellaneous plugins:
645 Selects multiple value lists based on patterns or regular expressions
646 and creates new aggregated values lists from those.
649 Checks values against configured thresholds and creates notifications if
650 values are out of bounds. See collectd-threshold(5) for details.
653 Sets the hostname to a unique identifier. This is meant for setups
654 where each client may migrate to another physical host, possibly going
655 through one or more name changes in the process.
657 * Performance: Since collectd is running as a daemon it doesn't spend much
658 time starting up again and again. With the exception of the exec plugin no
659 processes are forked. Caching in output plugins, such as the rrdtool and
660 network plugins, makes sure your resources are used efficiently. Also,
661 since collectd is programmed multithreaded it benefits from hyper-threading
662 and multicore processors and makes sure that the daemon isn't idle if only
663 one plugin waits for an IO-operation to complete.
665 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
666 as possible and the default values should be okay for most users.
672 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
673 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
674 for a list of options and a syntax description.
676 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
677 files. The usual place for these files is beneath `/var/lib/collectd'.
679 * When using some of the plugins, collectd needs to run as user root, since
680 only root can do certain things, such as craft ICMP packages needed to ping
681 other hosts. collectd should NOT be installed setuid root since it can be
682 used to overwrite valuable files!
684 * Sample scripts to generate graphs reside in `contrib/' in the source
685 package or somewhere near `/usr/share/doc/collectd' in most distributions.
686 Please be aware that those script are meant as a starting point for your
687 own experiments.. Some of them require the `RRDs' Perl module.
688 (`librrds-perl' on Debian) If you have written a more sophisticated
689 solution please share it with us.
691 * The RRAs of the automatically created RRD files depend on the `step'
692 and `heartbeat' settings given. If change these settings you may need to
693 re-create the files, losing all data. Please be aware of that when changing
694 the values and read the rrdtool(1) manpage thoroughly.
697 collectd and chkrootkit
698 -----------------------
700 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
701 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
702 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
703 this case, collectd is a legitimate sniffer and the report should be
704 considered to be a false positive. However, you might want to check that
705 this really is collectd and not some other, illegitimate sniffer.
711 To compile collectd from source you will need:
713 * Usual suspects: C compiler, linker, preprocessor, make, ...
715 collectd makes use of some common C99 features, e.g. compound literals and
716 mixed declarations, and therefore requires a C99 compatible compiler.
718 On Debian and Ubuntu, the "build-essential" package should pull in
719 everything that's necessary.
721 * A POSIX-threads (pthread) implementation.
722 Since gathering some statistics is slow (network connections, slow devices,
723 etc) collectd is parallelized. The POSIX threads interface is being
724 used and should be found in various implementations for hopefully all
727 * When building from the Git repository, flex (tokenizer) and bison (parser
728 generator) are required. Release tarballs include the generated files – you
729 don't need these packages in that case.
731 * aerotools-ng (optional)
732 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
733 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
734 nor does it feature an installation routine. Therefore, you need to point
735 collectd's configure script at the source directory of the `aerotools-ng'
737 <https://github.com/lynix/aerotools-ng>
739 * CoreFoundation.framework and IOKit.framework (optional)
740 For compiling on Darwin in general and the `apple_sensors' plugin in
742 <http://developer.apple.com/corefoundation/>
744 * libatasmart (optional)
745 Used by the `smart' plugin.
746 <http://git.0pointer.de/?p=libatasmart.git>
749 The `turbostat' plugin can optionally build Linux Capabilities support,
750 which avoids full privileges requirement (aka. running as root) to read
752 <http://sites.google.com/site/fullycapable/>
754 * libclntsh (optional)
755 Used by the `oracle' plugin.
757 * libhiredis (optional)
758 Used by the redis plugin. Please note that you require a 0.10.0 version
759 or higher. <https://github.com/redis/hiredis>
762 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
763 `curl_xml', `nginx', or `write_http' plugin.
764 <http://curl.haxx.se/>
767 Used by the `dbi' plugin to connect to various databases.
768 <http://libdbi.sourceforge.net/>
770 * libesmtp (optional)
771 For the `notify_email' plugin.
772 <http://www.stafford.uklinux.net/libesmtp/>
774 * libganglia (optional)
775 Used by the `gmond' plugin to process data received from Ganglia.
776 <http://ganglia.info/>
779 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
783 * libgcrypt (optional)
784 Used by the `network' plugin for encryption and authentication.
785 <http://www.gnupg.org/>
788 Used by the `gps' plugin.
789 <http://developer.berlios.de/projects/gpsd/>
791 * libi2c-dev (optional)
792 Used for the plugin `barometer', provides just the i2c-dev.h header file
793 for user space i2c development.
796 For querying iptables counters.
797 <http://netfilter.org/>
799 * libjevents (optional)
800 The jevents library is used by the `intel_pmu' plugin to access the Linux
801 kernel perf interface.
802 Note: the library should be build with -fPIC flag to be linked with
803 intel_pmu shared object correctly.
804 <https://github.com/andikleen/pmu-tools>
807 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
808 used by the `java' plugin to execute Java bytecode.
809 See docs/BUILD.java.md for detailed build instructions.
810 <http://openjdk.java.net/> (and others)
813 Used by the `openldap' plugin.
814 <http://www.openldap.org/>
817 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
818 <https://www.lua.org/>
821 Used by the `lvm' plugin.
822 <ftp://sources.redhat.com/pub/lvm2/>
824 * libmemcached (optional)
825 Used by the `memcachec' plugin to connect to a memcache daemon.
826 <http://tangent.org/552/libmemcached.html>
828 * libmicrohttpd (optional)
829 Used by the write_prometheus plugin to run an http daemon.
830 <http://www.gnu.org/software/libmicrohttpd/>
833 Used by the `netlink' plugin.
834 <http://www.netfilter.org/projects/libmnl/>
836 * libmodbus (optional)
837 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
838 `modbus' plugin works with version 2.0.3 of the library – due to frequent
839 API changes other versions may or may not compile cleanly.
840 <http://www.libmodbus.org/>
842 * libmysqlclient (optional)
843 Unsurprisingly used by the `mysql' plugin.
844 <http://dev.mysql.com/>
846 * libnetapp (optional)
847 Required for the `netapp' plugin.
848 This library is part of the “Manage ONTAP SDK” published by NetApp.
850 * libnetsnmp (optional)
851 For the `snmp' and 'snmp_agent' plugins.
852 <http://www.net-snmp.org/>
854 * libnetsnmpagent (optional)
855 Required for the 'snmp_agent' plugin.
856 <http://www.net-snmp.org/>
858 * libnotify (optional)
859 For the `notify_desktop' plugin.
860 <http://www.galago-project.org/>
862 * libopenipmi (optional)
863 Used by the `ipmi' plugin to prove IPMI devices.
864 <http://openipmi.sourceforge.net/>
866 * liboping (optional)
867 Used by the `ping' plugin to send and receive ICMP packets.
868 <http://octo.it/liboping/>
870 * libowcapi (optional)
871 Used by the `onewire' plugin to read values from onewire sensors (or the
873 <http://www.owfs.org/>
876 Used to capture packets by the `dns' plugin.
877 <http://www.tcpdump.org/>
879 * libperfstat (optional)
880 Used by various plugins to gather statistics under AIX.
883 Obviously used by the `perl' plugin. The library has to be compiled with
884 ithread support (introduced in Perl 5.6.0).
885 <http://www.perl.org/>
888 The PostgreSQL C client library used by the `postgresql' plugin.
889 <http://www.postgresql.org/>
892 The PQoS library for Intel(R) Resource Director Technology used by the
894 <https://github.com/01org/intel-cmt-cat>
896 * libprotobuf, protoc 3.0+ (optional)
897 Used by the `grpc' plugin to generate service stubs and code to handle
898 network packets of collectd's protobuf-based network protocol.
899 <https://developers.google.com/protocol-buffers/>
901 * libprotobuf-c, protoc-c (optional)
902 Used by the `pinba' plugin to generate a parser for the network packets
903 sent by the Pinba PHP extension.
904 <http://code.google.com/p/protobuf-c/>
906 * libpython (optional)
907 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
909 <http://www.python.org/>
911 * librabbitmq (optional; also called “rabbitmq-c”)
912 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
913 <http://hg.rabbitmq.com/rabbitmq-c/>
915 * librdkafka (optional; also called “rdkafka”)
916 Used by the `write_kafka' plugin for producing messages and sending them
918 <https://github.com/edenhill/librdkafka>
920 * librouteros (optional)
921 Used by the `routeros' plugin to connect to a device running `RouterOS'.
922 <http://octo.it/librouteros/>
925 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
926 client support which was added after version 1.3 of RRDtool. Versions 1.0,
927 1.2 and 1.3 are known to work with the `rrdtool' plugin.
928 <http://oss.oetiker.ch/rrdtool/>
930 * librt, libsocket, libkstat, libdevinfo (optional)
931 Various standard Solaris libraries which provide system functions.
932 <http://developers.sun.com/solaris/>
934 * libsensors (optional)
935 To read from `lm_sensors', see the `sensors' plugin.
936 <http://www.lm-sensors.org/>
938 * libsigrok (optional)
939 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
940 libzip, and optionally (depending on which drivers are enabled) on
941 libusb, libftdi and libudev.
943 * libstatgrab (optional)
944 Used by various plugins to collect statistics on systems other than Linux
946 <http://www.i-scream.org/libstatgrab/>
948 * libtokyotyrant (optional)
949 Used by the `tokyotyrant' plugin.
950 <http://1978th.net/tokyotyrant/>
952 * libupsclient/nut (optional)
953 For the `nut' plugin which queries nut's `upsd'.
954 <http://networkupstools.org/>
957 Collect statistics from virtual machines.
958 <http://libvirt.org/>
961 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
963 <http://xmlsoft.org/>
966 Used by the `xencpu' plugin.
967 <http://xenbits.xensource.com/>
970 <http://www.xmms.org/>
973 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
974 'ovs_stats' and `log_logstash' plugins.
975 <http://github.com/lloyd/yajl>
977 * libvarnish (optional)
978 Fetches statistics from a Varnish instance. This is needed for the
980 <http://varnish-cache.org>
982 * riemann-c-client (optional)
983 For the `write_riemann' plugin.
984 <https://github.com/algernon/riemann-c-client>
986 Configuring / Compiling / Installing
987 ------------------------------------
989 To configure, build and install collectd with the default settings, run
990 `./configure && make && make install'. For a complete list of configure
991 options and their description, run `./configure --help'.
993 By default, the configure script will check for all build dependencies and
994 disable all plugins whose requirements cannot be fulfilled (any other plugin
995 will be enabled). To enable a plugin, install missing dependencies (see
996 section `Prerequisites' above) and rerun `configure'. If you specify the
997 `--enable-<plugin>' configure option, the script will fail if the depen-
998 dencies for the specified plugin are not met. In that case you can force the
999 plugin to be built using the `--enable-<plugin>=force' configure option.
1000 This will most likely fail though unless you're working in a very unusual
1001 setup and you really know what you're doing. If you specify the
1002 `--disable-<plugin>' configure option, the plugin will not be built. If you
1003 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
1004 options, all plugins will be enabled or disabled respectively by default.
1005 Explicitly enabling or disabling a plugin overwrites the default for the
1006 specified plugin. These options are meant for package maintainers and should
1007 not be used in everyday situations.
1009 By default, collectd will be installed into `/opt/collectd'. You can adjust
1010 this setting by specifying the `--prefix' configure option - see INSTALL for
1011 details. If you pass DESTDIR=<path> to `make install', <path> will be
1012 prefixed to all installation directories. This might be useful when creating
1013 packages for collectd.
1015 Generating the configure script
1016 -------------------------------
1018 Collectd ships with a `build.sh' script to generate the `configure'
1019 script shipped with releases.
1021 To generate the `configure` script, you'll need the following dependencies:
1030 The `build.sh' script takes no arguments.
1036 To compile correctly collectd needs to be able to initialize static
1037 variables to NAN (Not A Number). Some C libraries, especially the GNU
1038 libc, have a problem with that.
1040 Luckily, with GCC it's possible to work around that problem: One can define
1041 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1042 ``implementation'' the configure script needs to compile and run a short
1043 test program. Obviously running a test program when doing a cross-
1044 compilation is, well, challenging.
1046 If you run into this problem, you can use the `--with-nan-emulation'
1047 configure option to force the use of this implementation. We can't promise
1048 that the compiled binary actually behaves as it should, but since NANs
1049 are likely never passed to the libm you have a good chance to be lucky.
1051 Likewise, collectd needs to know the layout of doubles in memory, in order
1052 to craft uniform network packets over different architectures. For this, it
1053 needs to know how to convert doubles into the memory layout used by x86. The
1054 configure script tries to figure this out by compiling and running a few
1055 small test programs. This is of course not possible when cross-compiling.
1056 You can use the `--with-fp-layout' option to tell the configure script which
1057 conversion method to assume. Valid arguments are:
1059 * `nothing' (12345678 -> 12345678)
1060 * `endianflip' (12345678 -> 87654321)
1061 * `intswap' (12345678 -> 56781234)
1067 Please use GitHub to report bugs and submit pull requests:
1068 <https://github.com/collectd/collectd/>.
1069 See CONTRIBUTING.md for details.
1071 For questions, development information and basically all other concerns please
1072 send an email to collectd's mailing list at
1073 <list at collectd.org>.
1075 For live discussion and more personal contact visit us in IRC, we're in
1076 channel #collectd on freenode.
1082 Florian octo Forster <octo at collectd.org>,
1083 Sebastian tokkee Harl <sh at tokkee.org>,
1084 and many contributors (see `AUTHORS').
projects / collectd.git / blob