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 Read errors from PCI Express Device Status and AER extended capabilities.
319 <https://www.design-reuse.com/articles/38374/pcie-error-logging-and-handling-on-a-typical-soc.html>
322 The perl plugin implements a Perl-interpreter into collectd. You can
323 write your own plugins in Perl and return arbitrary values using this
324 API. See collectd-perl(5).
327 Query statistics from BSD's packet filter "pf".
330 Receive and dispatch timing values from Pinba, a profiling extension for
334 Network latency: Time to reach the default gateway or another given
338 PostgreSQL database statistics: active server connections, transaction
339 numbers, block IO, table row manipulations.
342 PowerDNS name server statistics.
345 Process counts: Number of running, sleeping, zombie, ... processes.
348 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
351 The python plugin implements a Python interpreter into collectd. This
352 makes it possible to write plugins in Python which are executed by
353 collectd without the need to start a heavy interpreter every interval.
354 See collectd-python(5) for details.
357 The redis plugin gathers information from a Redis server, including:
358 uptime, used memory, total connections etc.
361 Query interface and wireless registration statistics from RouterOS.
364 RRDtool caching daemon (RRDcacheD) statistics.
367 System sensors, accessed using lm_sensors: Voltages, temperatures and
371 RX and TX of serial interfaces. Linux only; needs root privileges.
374 Uses libsigrok as a backend, allowing any sigrok-supported device
375 to have its measurements fed to collectd. This includes multimeters,
376 sound level meters, thermometers, and much more.
379 Collect SMART statistics, notably load cycle count, temperature
383 Read values from SNMP (Simple Network Management Protocol) enabled
384 network devices such as switches, routers, thermometers, rack monitoring
385 servers, etc. See collectd-snmp(5).
388 Acts as a StatsD server, reading values sent over the network from StatsD
389 clients and calculating rates and other aggregates out of these values.
392 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
395 Parse table-like structured files.
398 Follows (tails) log files, parses them by lines and submits matched
402 Follows (tails) files in CSV format, parses each line and submits
406 Bytes and operations read and written on tape devices. Solaris only.
409 Number of TCP connections to specific local and remote ports.
412 TeamSpeak2 server statistics.
415 Plugin to read values from `The Energy Detective' (TED).
418 Linux ACPI thermal zone information.
421 Reads the number of records and file size from a running Tokyo Tyrant
425 Reads CPU frequency and C-state residency on modern Intel
426 turbo-capable processors.
429 System uptime statistics.
432 Users currently logged in.
435 Various statistics from Varnish, an HTTP accelerator.
438 CPU, memory, disk and network I/O statistics from virtual machines.
441 Virtual memory statistics, e.g. the number of page-ins/-outs or the
442 number of pagefaults.
445 System resources used by Linux VServers.
446 See <http://linux-vserver.org/>.
449 Link quality of wireless cards. Linux only.
452 XEN Hypervisor CPU stats.
455 Bitrate and frequency of music played with XMMS.
458 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
461 Measures the percentage of cpu load per container (zone) under Solaris 10
465 Read data from Zookeeper's MNTR command.
467 * Output can be written or sent to various destinations by the following
471 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
472 0.9.1 server, such as RabbitMQ.
475 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
476 1.0 server, such as Qpid Dispatch Router or Apache Artemis Broker.
479 Write to comma separated values (CSV) files. This needs lots of
480 diskspace but is extremely portable and can be analysed with almost
481 every program that can analyse anything. Even Microsoft's Excel..
484 Send and receive values over the network using the gRPC framework.
487 It's possible to implement write plugins in Lua using the Lua
488 plugin. See collectd-lua(5) for details.
491 Publishes and subscribes to MQTT topics.
494 Send the data to a remote host to save the data somehow. This is useful
495 for large setups where the data should be saved by a dedicated machine.
498 Of course the values are propagated to plugins written in Perl, too, so
499 you can easily do weird stuff with the plugins we didn't dare think of
500 ;) See collectd-perl(5).
503 It's possible to implement write plugins in Python using the python
504 plugin. See collectd-python(5) for details.
507 Output to round-robin-database (RRD) files using the RRDtool caching
508 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
509 implementation of the caching done by the `rrdtool' plugin.
512 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
513 This is likely the most popular destination for such values. Since
514 updates to RRD-files are somewhat expensive this plugin can cache
515 updates to the files and write a bunch of updates at once, which lessens
519 Receives and handles queries from SNMP master agent and returns the data
520 collected by read plugins. Handles requests only for OIDs specified in
521 configuration file. To handle SNMP queries the plugin gets data from
522 collectd and translates requested values from collectd's internal format
526 One can query the values from the unixsock plugin whenever they're
527 needed. Please read collectd-unixsock(5) for a description on how that's
531 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
532 can be configured to avoid logging send errors (especially useful when
536 Sends the values collected by collectd to a web-server using HTTP POST
537 requests. The transmitted data is either in a form understood by the
538 Exec plugin or formatted in JSON.
541 Sends data to Apache Kafka, a distributed queue.
544 Writes data to the log
547 Sends data to MongoDB, a NoSQL database.
550 Publish values using an embedded HTTP server, in a format compatible
551 with Prometheus' collectd_exporter.
554 Sends the values to a Redis key-value database server.
557 Sends data to Riemann, a stream processing and monitoring system.
560 Sends data to Sensu, a stream processing and monitoring system, via the
561 Sensu client local TCP socket.
564 Sends data OpenTSDB, a scalable no master, no shared state time series
567 * Logging is, as everything in collectd, provided by plugins. The following
568 plugins keep us informed about what's going on:
571 Writes log messages to a file or STDOUT/STDERR.
574 Log messages are propagated to plugins written in Perl as well.
575 See collectd-perl(5).
578 It's possible to implement log plugins in Python using the python plugin.
579 See collectd-python(5) for details.
582 Logs to the standard UNIX logging mechanism, syslog.
585 Writes log messages formatted as logstash JSON events.
587 * Notifications can be handled by the following plugins:
590 Send a desktop notification to a notification daemon, as defined in
591 the Desktop Notification Specification. To actually display the
592 notifications, notification-daemon is required.
593 See http://www.galago-project.org/specs/notification/.
596 Send an E-mail with the notification message to the configured
600 Submit notifications as passive check results to a local nagios instance.
603 Execute a program or script to handle the notification.
604 See collectd-exec(5).
607 Writes the notification message to a file or STDOUT/STDERR.
610 Send the notification to a remote host to handle it somehow.
613 Notifications are propagated to plugins written in Perl as well.
614 See collectd-perl(5).
617 It's possible to implement notification plugins in Python using the
618 python plugin. See collectd-python(5) for details.
620 * Value processing can be controlled using the "filter chain" infrastructure
621 and "matches" and "targets". The following plugins are available:
623 - match_empty_counter
624 Match counter values which are currently zero.
627 Match values using a hash function of the hostname.
630 Match values by their identifier based on regular expressions.
633 Match values with an invalid timestamp.
636 Select values by their data sources' values.
638 - target_notification
639 Create and dispatch a notification.
642 Replace parts of an identifier using regular expressions.
645 Scale (multiply) values by an arbitrary value.
648 Set (overwrite) entire parts of an identifier.
650 * Miscellaneous plugins:
653 Selects multiple value lists based on patterns or regular expressions
654 and creates new aggregated values lists from those.
657 Checks values against configured thresholds and creates notifications if
658 values are out of bounds. See collectd-threshold(5) for details.
661 Sets the hostname to a unique identifier. This is meant for setups
662 where each client may migrate to another physical host, possibly going
663 through one or more name changes in the process.
665 * Performance: Since collectd is running as a daemon it doesn't spend much
666 time starting up again and again. With the exception of the exec plugin no
667 processes are forked. Caching in output plugins, such as the rrdtool and
668 network plugins, makes sure your resources are used efficiently. Also,
669 since collectd is programmed multithreaded it benefits from hyper-threading
670 and multicore processors and makes sure that the daemon isn't idle if only
671 one plugin waits for an IO-operation to complete.
673 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
674 as possible and the default values should be okay for most users.
680 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
681 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
682 for a list of options and a syntax description.
684 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
685 files. The usual place for these files is beneath `/var/lib/collectd'.
687 * When using some of the plugins, collectd needs to run as user root, since
688 only root can do certain things, such as craft ICMP packages needed to ping
689 other hosts. collectd should NOT be installed setuid root since it can be
690 used to overwrite valuable files!
692 * Sample scripts to generate graphs reside in `contrib/' in the source
693 package or somewhere near `/usr/share/doc/collectd' in most distributions.
694 Please be aware that those script are meant as a starting point for your
695 own experiments.. Some of them require the `RRDs' Perl module.
696 (`librrds-perl' on Debian) If you have written a more sophisticated
697 solution please share it with us.
699 * The RRAs of the automatically created RRD files depend on the `step'
700 and `heartbeat' settings given. If change these settings you may need to
701 re-create the files, losing all data. Please be aware of that when changing
702 the values and read the rrdtool(1) manpage thoroughly.
705 collectd and chkrootkit
706 -----------------------
708 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
709 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
710 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
711 this case, collectd is a legitimate sniffer and the report should be
712 considered to be a false positive. However, you might want to check that
713 this really is collectd and not some other, illegitimate sniffer.
719 To compile collectd from source you will need:
721 * Usual suspects: C compiler, linker, preprocessor, make, ...
723 collectd makes use of some common C99 features, e.g. compound literals and
724 mixed declarations, and therefore requires a C99 compatible compiler.
726 On Debian and Ubuntu, the "build-essential" package should pull in
727 everything that's necessary.
729 * A POSIX-threads (pthread) implementation.
730 Since gathering some statistics is slow (network connections, slow devices,
731 etc) collectd is parallelized. The POSIX threads interface is being
732 used and should be found in various implementations for hopefully all
735 * When building from the Git repository, flex (tokenizer) and bison (parser
736 generator) are required. Release tarballs include the generated files – you
737 don't need these packages in that case.
739 * aerotools-ng (optional)
740 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
741 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
742 nor does it feature an installation routine. Therefore, you need to point
743 collectd's configure script at the source directory of the `aerotools-ng'
745 <https://github.com/lynix/aerotools-ng>
747 * CoreFoundation.framework and IOKit.framework (optional)
748 For compiling on Darwin in general and the `apple_sensors' plugin in
750 <http://developer.apple.com/corefoundation/>
752 * libatasmart (optional)
753 Used by the `smart' plugin.
754 <http://git.0pointer.de/?p=libatasmart.git>
757 The `turbostat' plugin can optionally build Linux Capabilities support,
758 which avoids full privileges requirement (aka. running as root) to read
760 <http://sites.google.com/site/fullycapable/>
762 * libclntsh (optional)
763 Used by the `oracle' plugin.
765 * libhiredis (optional)
766 Used by the redis plugin. Please note that you require a 0.10.0 version
767 or higher. <https://github.com/redis/hiredis>
770 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
771 `curl_xml', `nginx', or `write_http' plugin.
772 <http://curl.haxx.se/>
775 Used by the `dbi' plugin to connect to various databases.
776 <http://libdbi.sourceforge.net/>
778 * libesmtp (optional)
779 For the `notify_email' plugin.
780 <http://www.stafford.uklinux.net/libesmtp/>
782 * libganglia (optional)
783 Used by the `gmond' plugin to process data received from Ganglia.
784 <http://ganglia.info/>
787 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
791 * libgcrypt (optional)
792 Used by the `network' plugin for encryption and authentication.
793 <http://www.gnupg.org/>
796 Used by the `gps' plugin.
797 <http://developer.berlios.de/projects/gpsd/>
799 * libi2c-dev (optional)
800 Used for the plugin `barometer', provides just the i2c-dev.h header file
801 for user space i2c development.
804 For querying iptables counters.
805 <http://netfilter.org/>
807 * libjevents (optional)
808 The jevents library is used by the `intel_pmu' plugin to access the Linux
809 kernel perf interface.
810 Note: the library should be build with -fPIC flag to be linked with
811 intel_pmu shared object correctly.
812 <https://github.com/andikleen/pmu-tools>
815 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
816 used by the `java' plugin to execute Java bytecode.
817 See docs/BUILD.java.md for detailed build instructions.
818 <http://openjdk.java.net/> (and others)
821 Used by the `openldap' plugin.
822 <http://www.openldap.org/>
825 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
826 <https://www.lua.org/>
829 Used by the `lvm' plugin.
830 <ftp://sources.redhat.com/pub/lvm2/>
832 * libmemcached (optional)
833 Used by the `memcachec' plugin to connect to a memcache daemon.
834 <http://tangent.org/552/libmemcached.html>
836 * libmicrohttpd (optional)
837 Used by the write_prometheus plugin to run an http daemon.
838 <http://www.gnu.org/software/libmicrohttpd/>
841 Used by the `netlink' plugin.
842 <http://www.netfilter.org/projects/libmnl/>
844 * libmodbus (optional)
845 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
846 `modbus' plugin works with version 2.0.3 of the library – due to frequent
847 API changes other versions may or may not compile cleanly.
848 <http://www.libmodbus.org/>
850 * libmysqlclient (optional)
851 Unsurprisingly used by the `mysql' plugin.
852 <http://dev.mysql.com/>
854 * libnetapp (optional)
855 Required for the `netapp' plugin.
856 This library is part of the “Manage ONTAP SDK” published by NetApp.
858 * libnetsnmp (optional)
859 For the `snmp' and 'snmp_agent' plugins.
860 <http://www.net-snmp.org/>
862 * libnetsnmpagent (optional)
863 Required for the 'snmp_agent' plugin.
864 <http://www.net-snmp.org/>
866 * libnotify (optional)
867 For the `notify_desktop' plugin.
868 <http://www.galago-project.org/>
870 * libopenipmi (optional)
871 Used by the `ipmi' plugin to prove IPMI devices.
872 <http://openipmi.sourceforge.net/>
874 * liboping (optional)
875 Used by the `ping' plugin to send and receive ICMP packets.
876 <http://octo.it/liboping/>
878 * libowcapi (optional)
879 Used by the `onewire' plugin to read values from onewire sensors (or the
881 <http://www.owfs.org/>
884 Used to capture packets by the `dns' plugin.
885 <http://www.tcpdump.org/>
887 * libperfstat (optional)
888 Used by various plugins to gather statistics under AIX.
891 Obviously used by the `perl' plugin. The library has to be compiled with
892 ithread support (introduced in Perl 5.6.0).
893 <http://www.perl.org/>
896 The PostgreSQL C client library used by the `postgresql' plugin.
897 <http://www.postgresql.org/>
900 The PQoS library for Intel(R) Resource Director Technology used by the
902 <https://github.com/01org/intel-cmt-cat>
904 * libprotobuf, protoc 3.0+ (optional)
905 Used by the `grpc' plugin to generate service stubs and code to handle
906 network packets of collectd's protobuf-based network protocol.
907 <https://developers.google.com/protocol-buffers/>
909 * libprotobuf-c, protoc-c (optional)
910 Used by the `pinba' plugin to generate a parser for the network packets
911 sent by the Pinba PHP extension.
912 <http://code.google.com/p/protobuf-c/>
914 * libpython (optional)
915 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
917 <http://www.python.org/>
919 * libqpid-proton (optional)
920 Used by the `amqp1' plugin for AMQP 1.0 connections, for example to
922 <http://qpid.apache.org/>
924 * librabbitmq (optional; also called “rabbitmq-c”)
925 Used by the `amqp' plugin for AMQP 0.9.1 connections, for example to
927 <http://hg.rabbitmq.com/rabbitmq-c/>
929 * librdkafka (optional; also called “rdkafka”)
930 Used by the `write_kafka' plugin for producing messages and sending them
932 <https://github.com/edenhill/librdkafka>
934 * librouteros (optional)
935 Used by the `routeros' plugin to connect to a device running `RouterOS'.
936 <http://octo.it/librouteros/>
939 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
940 client support which was added after version 1.3 of RRDtool. Versions 1.0,
941 1.2 and 1.3 are known to work with the `rrdtool' plugin.
942 <http://oss.oetiker.ch/rrdtool/>
944 * librt, libsocket, libkstat, libdevinfo (optional)
945 Various standard Solaris libraries which provide system functions.
946 <http://developers.sun.com/solaris/>
948 * libsensors (optional)
949 To read from `lm_sensors', see the `sensors' plugin.
950 <http://www.lm-sensors.org/>
952 * libsigrok (optional)
953 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
954 libzip, and optionally (depending on which drivers are enabled) on
955 libusb, libftdi and libudev.
957 * libstatgrab (optional)
958 Used by various plugins to collect statistics on systems other than Linux
960 <http://www.i-scream.org/libstatgrab/>
962 * libtokyotyrant (optional)
963 Used by the `tokyotyrant' plugin.
964 <http://1978th.net/tokyotyrant/>
966 * libupsclient/nut (optional)
967 For the `nut' plugin which queries nut's `upsd'.
968 <http://networkupstools.org/>
971 Collect statistics from virtual machines.
972 <http://libvirt.org/>
975 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
977 <http://xmlsoft.org/>
980 Used by the `xencpu' plugin.
981 <http://xenbits.xensource.com/>
984 <http://www.xmms.org/>
987 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
988 'ovs_stats' and `log_logstash' plugins.
989 <http://github.com/lloyd/yajl>
991 * libvarnish (optional)
992 Fetches statistics from a Varnish instance. This is needed for the
994 <http://varnish-cache.org>
996 * riemann-c-client (optional)
997 For the `write_riemann' plugin.
998 <https://github.com/algernon/riemann-c-client>
1000 Configuring / Compiling / Installing
1001 ------------------------------------
1003 To configure, build and install collectd with the default settings, run
1004 `./configure && make && make install'. For a complete list of configure
1005 options and their description, run `./configure --help'.
1007 By default, the configure script will check for all build dependencies and
1008 disable all plugins whose requirements cannot be fulfilled (any other plugin
1009 will be enabled). To enable a plugin, install missing dependencies (see
1010 section `Prerequisites' above) and rerun `configure'. If you specify the
1011 `--enable-<plugin>' configure option, the script will fail if the depen-
1012 dencies for the specified plugin are not met. In that case you can force the
1013 plugin to be built using the `--enable-<plugin>=force' configure option.
1014 This will most likely fail though unless you're working in a very unusual
1015 setup and you really know what you're doing. If you specify the
1016 `--disable-<plugin>' configure option, the plugin will not be built. If you
1017 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
1018 options, all plugins will be enabled or disabled respectively by default.
1019 Explicitly enabling or disabling a plugin overwrites the default for the
1020 specified plugin. These options are meant for package maintainers and should
1021 not be used in everyday situations.
1023 By default, collectd will be installed into `/opt/collectd'. You can adjust
1024 this setting by specifying the `--prefix' configure option - see INSTALL for
1025 details. If you pass DESTDIR=<path> to `make install', <path> will be
1026 prefixed to all installation directories. This might be useful when creating
1027 packages for collectd.
1029 Generating the configure script
1030 -------------------------------
1032 Collectd ships with a `build.sh' script to generate the `configure'
1033 script shipped with releases.
1035 To generate the `configure` script, you'll need the following dependencies:
1044 The `build.sh' script takes no arguments.
1050 To compile correctly collectd needs to be able to initialize static
1051 variables to NAN (Not A Number). Some C libraries, especially the GNU
1052 libc, have a problem with that.
1054 Luckily, with GCC it's possible to work around that problem: One can define
1055 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1056 ``implementation'' the configure script needs to compile and run a short
1057 test program. Obviously running a test program when doing a cross-
1058 compilation is, well, challenging.
1060 If you run into this problem, you can use the `--with-nan-emulation'
1061 configure option to force the use of this implementation. We can't promise
1062 that the compiled binary actually behaves as it should, but since NANs
1063 are likely never passed to the libm you have a good chance to be lucky.
1065 Likewise, collectd needs to know the layout of doubles in memory, in order
1066 to craft uniform network packets over different architectures. For this, it
1067 needs to know how to convert doubles into the memory layout used by x86. The
1068 configure script tries to figure this out by compiling and running a few
1069 small test programs. This is of course not possible when cross-compiling.
1070 You can use the `--with-fp-layout' option to tell the configure script which
1071 conversion method to assume. Valid arguments are:
1073 * `nothing' (12345678 -> 12345678)
1074 * `endianflip' (12345678 -> 87654321)
1075 * `intswap' (12345678 -> 56781234)
1081 Please use GitHub to report bugs and submit pull requests:
1082 <https://github.com/collectd/collectd/>.
1083 See CONTRIBUTING.md for details.
1085 For questions, development information and basically all other concerns please
1086 send an email to collectd's mailing list at
1087 <list at collectd.org>.
1089 For live discussion and more personal contact visit us in IRC, we're in
1090 channel #collectd on freenode.
1096 Florian octo Forster <octo at collectd.org>,
1097 Sebastian tokkee Harl <sh at tokkee.org>,
1098 and many contributors (see `AUTHORS').
projects / collectd.git / blob