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 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 The perl plugin implements a Perl-interpreter into collectd. You can
322 write your own plugins in Perl and return arbitrary values using this
323 API. See collectd-perl(5).
326 Query statistics from BSD's packet filter "pf".
329 Receive and dispatch timing values from Pinba, a profiling extension for
333 Network latency: Time to reach the default gateway or another given
337 PostgreSQL database statistics: active server connections, transaction
338 numbers, block IO, table row manipulations.
341 PowerDNS name server statistics.
344 Process counts: Number of running, sleeping, zombie, ... processes.
347 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
350 The python plugin implements a Python interpreter into collectd. This
351 makes it possible to write plugins in Python which are executed by
352 collectd without the need to start a heavy interpreter every interval.
353 See collectd-python(5) for details.
356 The redis plugin gathers information from a Redis server, including:
357 uptime, used memory, total connections etc.
360 Query interface and wireless registration statistics from RouterOS.
363 RRDtool caching daemon (RRDcacheD) statistics.
366 System sensors, accessed using lm_sensors: Voltages, temperatures and
370 RX and TX of serial interfaces. Linux only; needs root privileges.
373 Uses libsigrok as a backend, allowing any sigrok-supported device
374 to have its measurements fed to collectd. This includes multimeters,
375 sound level meters, thermometers, and much more.
378 Collect SMART statistics, notably load cycle count, temperature
382 Read values from SNMP (Simple Network Management Protocol) enabled
383 network devices such as switches, routers, thermometers, rack monitoring
384 servers, etc. See collectd-snmp(5).
387 Acts as a StatsD server, reading values sent over the network from StatsD
388 clients and calculating rates and other aggregates out of these values.
391 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
394 Parse table-like structured files.
397 Follows (tails) log files, parses them by lines and submits matched
401 Follows (tails) files in CSV format, parses each line and submits
405 Bytes and operations read and written on tape devices. Solaris only.
408 Number of TCP connections to specific local and remote ports.
411 TeamSpeak2 server statistics.
414 Plugin to read values from `The Energy Detective' (TED).
417 Linux ACPI thermal zone information.
420 Reads the number of records and file size from a running Tokyo Tyrant
424 Reads CPU frequency and C-state residency on modern Intel
425 turbo-capable processors.
428 System uptime statistics.
431 Users currently logged in.
434 Various statistics from Varnish, an HTTP accelerator.
437 CPU, memory, disk and network I/O statistics from virtual machines.
440 Virtual memory statistics, e.g. the number of page-ins/-outs or the
441 number of pagefaults.
444 System resources used by Linux VServers.
445 See <http://linux-vserver.org/>.
448 Link quality of wireless cards. Linux only.
451 XEN Hypervisor CPU stats.
454 Bitrate and frequency of music played with XMMS.
457 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
460 Measures the percentage of cpu load per container (zone) under Solaris 10
464 Read data from Zookeeper's MNTR command.
466 * Output can be written or sent to various destinations by the following
470 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
471 0.9.1 server, such as RabbitMQ.
474 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
475 1.0 server, such as Qpid Dispatch Router or Apache Artemis Broker.
478 Write to comma separated values (CSV) files. This needs lots of
479 diskspace but is extremely portable and can be analysed with almost
480 every program that can analyse anything. Even Microsoft's Excel..
483 Send and receive values over the network using the gRPC framework.
486 It's possible to implement write plugins in Lua using the Lua
487 plugin. See collectd-lua(5) for details.
490 Publishes and subscribes to MQTT topics.
493 Send the data to a remote host to save the data somehow. This is useful
494 for large setups where the data should be saved by a dedicated machine.
497 Of course the values are propagated to plugins written in Perl, too, so
498 you can easily do weird stuff with the plugins we didn't dare think of
499 ;) See collectd-perl(5).
502 It's possible to implement write plugins in Python using the python
503 plugin. See collectd-python(5) for details.
506 Output to round-robin-database (RRD) files using the RRDtool caching
507 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
508 implementation of the caching done by the `rrdtool' plugin.
511 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
512 This is likely the most popular destination for such values. Since
513 updates to RRD-files are somewhat expensive this plugin can cache
514 updates to the files and write a bunch of updates at once, which lessens
518 Receives and handles queries from SNMP master agent and returns the data
519 collected by read plugins. Handles requests only for OIDs specified in
520 configuration file. To handle SNMP queries the plugin gets data from
521 collectd and translates requested values from collectd's internal format
525 One can query the values from the unixsock plugin whenever they're
526 needed. Please read collectd-unixsock(5) for a description on how that's
530 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
531 can be configured to avoid logging send errors (especially useful when
535 Sends the values collected by collectd to a web-server using HTTP POST
536 requests. The transmitted data is either in a form understood by the
537 Exec plugin or formatted in JSON.
540 Sends data to Apache Kafka, a distributed queue.
543 Writes data to the log
546 Sends data to MongoDB, a NoSQL database.
549 Publish values using an embedded HTTP server, in a format compatible
550 with Prometheus' collectd_exporter.
553 Sends the values to a Redis key-value database server.
556 Sends data to Riemann, a stream processing and monitoring system.
559 Sends data to Sensu, a stream processing and monitoring system, via the
560 Sensu client local TCP socket.
563 Sends data OpenTSDB, a scalable no master, no shared state time series
566 * Logging is, as everything in collectd, provided by plugins. The following
567 plugins keep us informed about what's going on:
570 Writes log messages to a file or STDOUT/STDERR.
573 Log messages are propagated to plugins written in Perl as well.
574 See collectd-perl(5).
577 It's possible to implement log plugins in Python using the python plugin.
578 See collectd-python(5) for details.
581 Logs to the standard UNIX logging mechanism, syslog.
584 Writes log messages formatted as logstash JSON events.
586 * Notifications can be handled by the following plugins:
589 Send a desktop notification to a notification daemon, as defined in
590 the Desktop Notification Specification. To actually display the
591 notifications, notification-daemon is required.
592 See http://www.galago-project.org/specs/notification/.
595 Send an E-mail with the notification message to the configured
599 Submit notifications as passive check results to a local nagios instance.
602 Execute a program or script to handle the notification.
603 See collectd-exec(5).
606 Writes the notification message to a file or STDOUT/STDERR.
609 Send the notification to a remote host to handle it somehow.
612 Notifications are propagated to plugins written in Perl as well.
613 See collectd-perl(5).
616 It's possible to implement notification plugins in Python using the
617 python plugin. See collectd-python(5) for details.
619 * Value processing can be controlled using the "filter chain" infrastructure
620 and "matches" and "targets". The following plugins are available:
622 - match_empty_counter
623 Match counter values which are currently zero.
626 Match values using a hash function of the hostname.
629 Match values by their identifier based on regular expressions.
632 Match values with an invalid timestamp.
635 Select values by their data sources' values.
637 - target_notification
638 Create and dispatch a notification.
641 Replace parts of an identifier using regular expressions.
644 Scale (multiply) values by an arbitrary value.
647 Set (overwrite) entire parts of an identifier.
649 * Miscellaneous plugins:
652 Selects multiple value lists based on patterns or regular expressions
653 and creates new aggregated values lists from those.
656 Checks values against configured thresholds and creates notifications if
657 values are out of bounds. See collectd-threshold(5) for details.
660 Sets the hostname to a unique identifier. This is meant for setups
661 where each client may migrate to another physical host, possibly going
662 through one or more name changes in the process.
664 * Performance: Since collectd is running as a daemon it doesn't spend much
665 time starting up again and again. With the exception of the exec plugin no
666 processes are forked. Caching in output plugins, such as the rrdtool and
667 network plugins, makes sure your resources are used efficiently. Also,
668 since collectd is programmed multithreaded it benefits from hyper-threading
669 and multicore processors and makes sure that the daemon isn't idle if only
670 one plugin waits for an IO-operation to complete.
672 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
673 as possible and the default values should be okay for most users.
679 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
680 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
681 for a list of options and a syntax description.
683 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
684 files. The usual place for these files is beneath `/var/lib/collectd'.
686 * When using some of the plugins, collectd needs to run as user root, since
687 only root can do certain things, such as craft ICMP packages needed to ping
688 other hosts. collectd should NOT be installed setuid root since it can be
689 used to overwrite valuable files!
691 * Sample scripts to generate graphs reside in `contrib/' in the source
692 package or somewhere near `/usr/share/doc/collectd' in most distributions.
693 Please be aware that those script are meant as a starting point for your
694 own experiments.. Some of them require the `RRDs' Perl module.
695 (`librrds-perl' on Debian) If you have written a more sophisticated
696 solution please share it with us.
698 * The RRAs of the automatically created RRD files depend on the `step'
699 and `heartbeat' settings given. If change these settings you may need to
700 re-create the files, losing all data. Please be aware of that when changing
701 the values and read the rrdtool(1) manpage thoroughly.
704 collectd and chkrootkit
705 -----------------------
707 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
708 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
709 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
710 this case, collectd is a legitimate sniffer and the report should be
711 considered to be a false positive. However, you might want to check that
712 this really is collectd and not some other, illegitimate sniffer.
718 To compile collectd from source you will need:
720 * Usual suspects: C compiler, linker, preprocessor, make, ...
722 collectd makes use of some common C99 features, e.g. compound literals and
723 mixed declarations, and therefore requires a C99 compatible compiler.
725 On Debian and Ubuntu, the "build-essential" package should pull in
726 everything that's necessary.
728 * A POSIX-threads (pthread) implementation.
729 Since gathering some statistics is slow (network connections, slow devices,
730 etc) collectd is parallelized. The POSIX threads interface is being
731 used and should be found in various implementations for hopefully all
734 * When building from the Git repository, flex (tokenizer) and bison (parser
735 generator) are required. Release tarballs include the generated files – you
736 don't need these packages in that case.
738 * aerotools-ng (optional)
739 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
740 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
741 nor does it feature an installation routine. Therefore, you need to point
742 collectd's configure script at the source directory of the `aerotools-ng'
744 <https://github.com/lynix/aerotools-ng>
746 * CoreFoundation.framework and IOKit.framework (optional)
747 For compiling on Darwin in general and the `apple_sensors' plugin in
749 <http://developer.apple.com/corefoundation/>
751 * libatasmart (optional)
752 Used by the `smart' plugin.
753 <http://git.0pointer.de/?p=libatasmart.git>
756 The `turbostat' plugin can optionally build Linux Capabilities support,
757 which avoids full privileges requirement (aka. running as root) to read
759 <http://sites.google.com/site/fullycapable/>
761 * libclntsh (optional)
762 Used by the `oracle' plugin.
764 * libhiredis (optional)
765 Used by the redis plugin. Please note that you require a 0.10.0 version
766 or higher. <https://github.com/redis/hiredis>
769 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
770 `curl_xml', `nginx', or `write_http' plugin.
771 <http://curl.haxx.se/>
774 Used by the `dbi' plugin to connect to various databases.
775 <http://libdbi.sourceforge.net/>
777 * libesmtp (optional)
778 For the `notify_email' plugin.
779 <http://www.stafford.uklinux.net/libesmtp/>
781 * libganglia (optional)
782 Used by the `gmond' plugin to process data received from Ganglia.
783 <http://ganglia.info/>
786 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
790 * libgcrypt (optional)
791 Used by the `network' plugin for encryption and authentication.
792 <http://www.gnupg.org/>
795 Used by the `gps' plugin.
796 <http://developer.berlios.de/projects/gpsd/>
798 * libi2c-dev (optional)
799 Used for the plugin `barometer', provides just the i2c-dev.h header file
800 for user space i2c development.
803 For querying iptables counters.
804 <http://netfilter.org/>
806 * libjevents (optional)
807 The jevents library is used by the `intel_pmu' plugin to access the Linux
808 kernel perf interface.
809 Note: the library should be build with -fPIC flag to be linked with
810 intel_pmu shared object correctly.
811 <https://github.com/andikleen/pmu-tools>
814 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
815 used by the `java' plugin to execute Java bytecode.
816 See docs/BUILD.java.md for detailed build instructions.
817 <http://openjdk.java.net/> (and others)
820 Used by the `openldap' plugin.
821 <http://www.openldap.org/>
824 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
825 <https://www.lua.org/>
828 Used by the `lvm' plugin.
829 <ftp://sources.redhat.com/pub/lvm2/>
831 * libmemcached (optional)
832 Used by the `memcachec' plugin to connect to a memcache daemon.
833 <http://tangent.org/552/libmemcached.html>
835 * libmicrohttpd (optional)
836 Used by the write_prometheus plugin to run an http daemon.
837 <http://www.gnu.org/software/libmicrohttpd/>
840 Used by the `netlink' plugin.
841 <http://www.netfilter.org/projects/libmnl/>
843 * libmodbus (optional)
844 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
845 `modbus' plugin works with version 2.0.3 of the library – due to frequent
846 API changes other versions may or may not compile cleanly.
847 <http://www.libmodbus.org/>
849 * libmysqlclient (optional)
850 Unsurprisingly used by the `mysql' plugin.
851 <http://dev.mysql.com/>
853 * libnetapp (optional)
854 Required for the `netapp' plugin.
855 This library is part of the “Manage ONTAP SDK” published by NetApp.
857 * libnetsnmp (optional)
858 For the `snmp' and 'snmp_agent' plugins.
859 <http://www.net-snmp.org/>
861 * libnetsnmpagent (optional)
862 Required for the 'snmp_agent' plugin.
863 <http://www.net-snmp.org/>
865 * libnotify (optional)
866 For the `notify_desktop' plugin.
867 <http://www.galago-project.org/>
869 * libopenipmi (optional)
870 Used by the `ipmi' plugin to prove IPMI devices.
871 <http://openipmi.sourceforge.net/>
873 * liboping (optional)
874 Used by the `ping' plugin to send and receive ICMP packets.
875 <http://octo.it/liboping/>
877 * libowcapi (optional)
878 Used by the `onewire' plugin to read values from onewire sensors (or the
880 <http://www.owfs.org/>
883 Used to capture packets by the `dns' plugin.
884 <http://www.tcpdump.org/>
886 * libperfstat (optional)
887 Used by various plugins to gather statistics under AIX.
890 Obviously used by the `perl' plugin. The library has to be compiled with
891 ithread support (introduced in Perl 5.6.0).
892 <http://www.perl.org/>
895 The PostgreSQL C client library used by the `postgresql' plugin.
896 <http://www.postgresql.org/>
899 The PQoS library for Intel(R) Resource Director Technology used by the
901 <https://github.com/01org/intel-cmt-cat>
903 * libprotobuf, protoc 3.0+ (optional)
904 Used by the `grpc' plugin to generate service stubs and code to handle
905 network packets of collectd's protobuf-based network protocol.
906 <https://developers.google.com/protocol-buffers/>
908 * libprotobuf-c, protoc-c (optional)
909 Used by the `pinba' plugin to generate a parser for the network packets
910 sent by the Pinba PHP extension.
911 <http://code.google.com/p/protobuf-c/>
913 * libpython (optional)
914 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
916 <http://www.python.org/>
918 * libqpid-proton (optional)
919 Used by the `amqp1' plugin for AMQP 1.0 connections, for example to
921 <http://qpid.apache.org/>
923 * librabbitmq (optional; also called “rabbitmq-c”)
924 Used by the `amqp' plugin for AMQP 0.9.1 connections, for example to
926 <http://hg.rabbitmq.com/rabbitmq-c/>
928 * librdkafka (optional; also called “rdkafka”)
929 Used by the `write_kafka' plugin for producing messages and sending them
931 <https://github.com/edenhill/librdkafka>
933 * librouteros (optional)
934 Used by the `routeros' plugin to connect to a device running `RouterOS'.
935 <http://octo.it/librouteros/>
938 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
939 client support which was added after version 1.3 of RRDtool. Versions 1.0,
940 1.2 and 1.3 are known to work with the `rrdtool' plugin.
941 <http://oss.oetiker.ch/rrdtool/>
943 * librt, libsocket, libkstat, libdevinfo (optional)
944 Various standard Solaris libraries which provide system functions.
945 <http://developers.sun.com/solaris/>
947 * libsensors (optional)
948 To read from `lm_sensors', see the `sensors' plugin.
949 <http://www.lm-sensors.org/>
951 * libsigrok (optional)
952 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
953 libzip, and optionally (depending on which drivers are enabled) on
954 libusb, libftdi and libudev.
956 * libstatgrab (optional)
957 Used by various plugins to collect statistics on systems other than Linux
959 <http://www.i-scream.org/libstatgrab/>
961 * libtokyotyrant (optional)
962 Used by the `tokyotyrant' plugin.
963 <http://1978th.net/tokyotyrant/>
965 * libupsclient/nut (optional)
966 For the `nut' plugin which queries nut's `upsd'.
967 <http://networkupstools.org/>
970 Collect statistics from virtual machines.
971 <http://libvirt.org/>
974 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
976 <http://xmlsoft.org/>
979 Used by the `xencpu' plugin.
980 <http://xenbits.xensource.com/>
983 <http://www.xmms.org/>
986 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
987 'ovs_stats' and `log_logstash' plugins.
988 <http://github.com/lloyd/yajl>
990 * libvarnish (optional)
991 Fetches statistics from a Varnish instance. This is needed for the
993 <http://varnish-cache.org>
995 * riemann-c-client (optional)
996 For the `write_riemann' plugin.
997 <https://github.com/algernon/riemann-c-client>
999 Configuring / Compiling / Installing
1000 ------------------------------------
1002 To configure, build and install collectd with the default settings, run
1003 `./configure && make && make install'. For a complete list of configure
1004 options and their description, run `./configure --help'.
1006 By default, the configure script will check for all build dependencies and
1007 disable all plugins whose requirements cannot be fulfilled (any other plugin
1008 will be enabled). To enable a plugin, install missing dependencies (see
1009 section `Prerequisites' above) and rerun `configure'. If you specify the
1010 `--enable-<plugin>' configure option, the script will fail if the depen-
1011 dencies for the specified plugin are not met. In that case you can force the
1012 plugin to be built using the `--enable-<plugin>=force' configure option.
1013 This will most likely fail though unless you're working in a very unusual
1014 setup and you really know what you're doing. If you specify the
1015 `--disable-<plugin>' configure option, the plugin will not be built. If you
1016 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
1017 options, all plugins will be enabled or disabled respectively by default.
1018 Explicitly enabling or disabling a plugin overwrites the default for the
1019 specified plugin. These options are meant for package maintainers and should
1020 not be used in everyday situations.
1022 By default, collectd will be installed into `/opt/collectd'. You can adjust
1023 this setting by specifying the `--prefix' configure option - see INSTALL for
1024 details. If you pass DESTDIR=<path> to `make install', <path> will be
1025 prefixed to all installation directories. This might be useful when creating
1026 packages for collectd.
1028 Generating the configure script
1029 -------------------------------
1031 Collectd ships with a `build.sh' script to generate the `configure'
1032 script shipped with releases.
1034 To generate the `configure` script, you'll need the following dependencies:
1043 The `build.sh' script takes no arguments.
1049 To compile correctly collectd needs to be able to initialize static
1050 variables to NAN (Not A Number). Some C libraries, especially the GNU
1051 libc, have a problem with that.
1053 Luckily, with GCC it's possible to work around that problem: One can define
1054 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1055 ``implementation'' the configure script needs to compile and run a short
1056 test program. Obviously running a test program when doing a cross-
1057 compilation is, well, challenging.
1059 If you run into this problem, you can use the `--with-nan-emulation'
1060 configure option to force the use of this implementation. We can't promise
1061 that the compiled binary actually behaves as it should, but since NANs
1062 are likely never passed to the libm you have a good chance to be lucky.
1064 Likewise, collectd needs to know the layout of doubles in memory, in order
1065 to craft uniform network packets over different architectures. For this, it
1066 needs to know how to convert doubles into the memory layout used by x86. The
1067 configure script tries to figure this out by compiling and running a few
1068 small test programs. This is of course not possible when cross-compiling.
1069 You can use the `--with-fp-layout' option to tell the configure script which
1070 conversion method to assume. Valid arguments are:
1072 * `nothing' (12345678 -> 12345678)
1073 * `endianflip' (12345678 -> 87654321)
1074 * `intswap' (12345678 -> 56781234)
1080 Please use GitHub to report bugs and submit pull requests:
1081 <https://github.com/collectd/collectd/>.
1082 See CONTRIBUTING.md for details.
1084 For questions, development information and basically all other concerns please
1085 send an email to collectd's mailing list at
1086 <list at collectd.org>.
1088 For live discussion and more personal contact visit us in IRC, we're in
1089 channel #collectd on freenode.
1095 Florian octo Forster <octo at collectd.org>,
1096 Sebastian tokkee Harl <sh at tokkee.org>,
1097 and many contributors (see `AUTHORS').
projects / collectd.git / blob