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.
104 Collect individual drbd resource statistics.
107 Email statistics: Count, traffic, spam scores and checks.
108 See collectd-email(5).
111 Amount of entropy available to the system.
114 Network interface card statistics.
117 Values gathered by a custom program or script.
118 See collectd-exec(5).
121 File handles statistics.
124 Count the number of files in directories.
127 Linux file-system based caching framework statistics.
130 Receive multicast traffic from Ganglia instances.
133 Monitor gps related data through gpsd.
136 Hard disk temperatures using hddtempd.
139 Report the number of used and free hugepages. More info on
140 hugepages can be found here:
141 https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt.
144 The intel_pmu plugin reads performance counters provided by the Linux
145 kernel perf interface. The plugin uses jevents library to resolve named
146 events to perf events and access perf interface.
149 The intel_rdt plugin collects information provided by monitoring features
150 of Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
151 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features
152 provide information about utilization of shared resources like last level
153 cache occupancy, local memory bandwidth usage, remote memory bandwidth
154 usage, instructions per clock.
155 <https://01.org/packet-processing/cache-monitoring-technology-memory-bandwidth-monitoring-cache-allocation-technology-code-and-data>
158 Interface traffic: Number of octets, packets and errors for each
162 IPC counters: semaphores used, number of allocated segments in shared
166 IPMI (Intelligent Platform Management Interface) sensors information.
169 Iptables' counters: Number of bytes that were matched by a certain
173 IPVS connection statistics (number of connections, octets and packets
174 for each service and destination).
175 See http://www.linuxvirtualserver.org/software/index.html.
178 IRQ counters: Frequency in which certain interrupts occur.
181 Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
183 See docs/BUILD.java.md for detailed build instructions.
186 System load average over the last 1, 5 and 15 minutes.
189 Detailed CPU statistics of the “Logical Partitions” virtualization
190 technique built into IBM's POWER processors.
193 The Lua plugin implements a Lua interpreter into collectd. This
194 makes it possible to write plugins in Lua which are executed by
195 collectd without the need to start a heavy interpreter every interval.
196 See collectd-lua(5) for details.
199 Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
200 “Logical Volume Manager” (LVM).
203 Queries very detailed usage statistics from wireless LAN adapters and
204 interfaces that use the Atheros chipset and the MadWifi driver.
207 Motherboard sensors: temperature, fan speed and voltage information,
211 Monitor machine check exceptions (hardware errors detected by hardware
212 and reported to software) reported by mcelog and generate appropriate
213 notifications when machine check exceptions are detected.
216 Linux software-RAID device information (number of active, failed, spare
220 Query and parse data from a memcache daemon (memcached).
223 Statistics of the memcached distributed caching system.
224 <http://www.danga.com/memcached/>
227 Memory utilization: Memory occupied by running processes, page cache,
228 buffer cache and free.
231 Collects CPU usage, memory usage, temperatures and power consumption from
232 Intel Many Integrated Core (MIC) CPUs.
235 Reads values from Modbus/TCP enabled devices. Supports reading values
236 from multiple "slaves" so gateway devices can be used.
239 Information provided by serial multimeters, such as the `Metex
243 MySQL server statistics: Commands issued, handlers triggered, thread
244 usage, query cache utilization and traffic/octets sent and received.
247 Plugin to query performance values from a NetApp storage system using the
248 “Manage ONTAP” SDK provided by NetApp.
251 Very detailed Linux network interface and routing statistics. You can get
252 (detailed) information on interfaces, qdiscs, classes, and, if you can
253 make use of it, filters.
256 Receive values that were collected by other hosts. Large setups will
257 want to collect the data on one dedicated machine, and this is the
258 plugin of choice for that.
261 NFS Procedures: Which NFS command were called how often. Only NFSv2 and
265 Collects statistics from `nginx' (speak: engine X), a HTTP and mail
269 NTP daemon statistics: Local clock drift, offset to peers, etc.
272 Information about Non-Uniform Memory Access (NUMA).
275 Network UPS tools: UPS current, voltage, power, charge, utilisation,
276 temperature, etc. See upsd(8).
279 Queries routing information from the “Optimized Link State Routing”
282 - onewire (EXPERIMENTAL!)
283 Read onewire sensors using the owcapu library of the owfs project.
284 Please read in collectd.conf(5) why this plugin is experimental.
287 Read monitoring information from OpenLDAP's cn=Monitor subtree.
290 RX and TX of each client in openvpn-status.log (status-version 2).
291 <http://openvpn.net/index.php/documentation/howto.html>
294 Query data from an Oracle database.
297 The plugin monitors the link status of Open vSwitch (OVS) connected
298 interfaces, dispatches the values to collectd and sends the notification
299 whenever the link state change occurs in the OVS database. It requires
300 YAJL library to be installed.
301 Detailed instructions for installing and setting up Open vSwitch, see
303 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
306 The plugin collects the statistics of OVS connected bridges and
307 interfaces. It requires YAJL library to be installed.
308 Detailed instructions for installing and setting up Open vSwitch, see
310 <http://openvswitch.org/support/dist-docs/INSTALL.rst.html>
313 The perl plugin implements a Perl-interpreter into collectd. You can
314 write your own plugins in Perl and return arbitrary values using this
315 API. See collectd-perl(5).
318 Query statistics from BSD's packet filter "pf".
321 Receive and dispatch timing values from Pinba, a profiling extension for
325 Network latency: Time to reach the default gateway or another given
329 PostgreSQL database statistics: active server connections, transaction
330 numbers, block IO, table row manipulations.
333 PowerDNS name server statistics.
336 Process counts: Number of running, sleeping, zombie, ... processes.
339 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
342 The python plugin implements a Python interpreter into collectd. This
343 makes it possible to write plugins in Python which are executed by
344 collectd without the need to start a heavy interpreter every interval.
345 See collectd-python(5) for details.
348 The redis plugin gathers information from a Redis server, including:
349 uptime, used memory, total connections etc.
352 Query interface and wireless registration statistics from RouterOS.
355 RRDtool caching daemon (RRDcacheD) statistics.
358 System sensors, accessed using lm_sensors: Voltages, temperatures and
362 RX and TX of serial interfaces. Linux only; needs root privileges.
365 Uses libsigrok as a backend, allowing any sigrok-supported device
366 to have its measurements fed to collectd. This includes multimeters,
367 sound level meters, thermometers, and much more.
370 Collect SMART statistics, notably load cycle count, temperature
374 Read values from SNMP (Simple Network Management Protocol) enabled
375 network devices such as switches, routers, thermometers, rack monitoring
376 servers, etc. See collectd-snmp(5).
379 Acts as a StatsD server, reading values sent over the network from StatsD
380 clients and calculating rates and other aggregates out of these values.
383 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
386 Parse table-like structured files.
389 Follows (tails) log files, parses them by lines and submits matched
393 Follows (tails) files in CSV format, parses each line and submits
397 Bytes and operations read and written on tape devices. Solaris only.
400 Number of TCP connections to specific local and remote ports.
403 TeamSpeak2 server statistics.
406 Plugin to read values from `The Energy Detective' (TED).
409 Linux ACPI thermal zone information.
412 Reads the number of records and file size from a running Tokyo Tyrant
416 Reads CPU frequency and C-state residency on modern Intel
417 turbo-capable processors.
420 System uptime statistics.
423 Users currently logged in.
426 Various statistics from Varnish, an HTTP accelerator.
429 CPU, memory, disk and network I/O statistics from virtual machines.
432 Virtual memory statistics, e.g. the number of page-ins/-outs or the
433 number of pagefaults.
436 System resources used by Linux VServers.
437 See <http://linux-vserver.org/>.
440 Link quality of wireless cards. Linux only.
443 XEN Hypervisor CPU stats.
446 Bitrate and frequency of music played with XMMS.
449 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
452 Measures the percentage of cpu load per container (zone) under Solaris 10
456 Read data from Zookeeper's MNTR command.
458 * Output can be written or sent to various destinations by the following
462 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
463 server, such as RabbitMQ.
466 Write to comma separated values (CSV) files. This needs lots of
467 diskspace but is extremely portable and can be analysed with almost
468 every program that can analyse anything. Even Microsoft's Excel..
471 Send and receive values over the network using the gRPC framework.
474 It's possible to implement write plugins in Lua using the Lua
475 plugin. See collectd-lua(5) for details.
478 Publishes and subscribes to MQTT topics.
481 Send the data to a remote host to save the data somehow. This is useful
482 for large setups where the data should be saved by a dedicated machine.
485 Of course the values are propagated to plugins written in Perl, too, so
486 you can easily do weird stuff with the plugins we didn't dare think of
487 ;) See collectd-perl(5).
490 It's possible to implement write plugins in Python using the python
491 plugin. See collectd-python(5) for details.
494 Output to round-robin-database (RRD) files using the RRDtool caching
495 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
496 implementation of the caching done by the `rrdtool' plugin.
499 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
500 This is likely the most popular destination for such values. Since
501 updates to RRD-files are somewhat expensive this plugin can cache
502 updates to the files and write a bunch of updates at once, which lessens
506 One can query the values from the unixsock plugin whenever they're
507 needed. Please read collectd-unixsock(5) for a description on how that's
511 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
512 can be configured to avoid logging send errors (especially useful when
516 Sends the values collected by collectd to a web-server using HTTP POST
517 requests. The transmitted data is either in a form understood by the
518 Exec plugin or formatted in JSON.
521 Sends data to Apache Kafka, a distributed queue.
524 Writes data to the log
527 Sends data to MongoDB, a NoSQL database.
530 Publish values using an embedded HTTP server, in a format compatible
531 with Prometheus' collectd_exporter.
534 Sends the values to a Redis key-value database server.
537 Sends data to Riemann, a stream processing and monitoring system.
540 Sends data to Sensu, a stream processing and monitoring system, via the
541 Sensu client local TCP socket.
544 Sends data OpenTSDB, a scalable no master, no shared state time series
547 * Logging is, as everything in collectd, provided by plugins. The following
548 plugins keep us informed about what's going on:
551 Writes log messages to a file or STDOUT/STDERR.
554 Log messages are propagated to plugins written in Perl as well.
555 See collectd-perl(5).
558 It's possible to implement log plugins in Python using the python plugin.
559 See collectd-python(5) for details.
562 Logs to the standard UNIX logging mechanism, syslog.
565 Writes log messages formatted as logstash JSON events.
567 * Notifications can be handled by the following plugins:
570 Send a desktop notification to a notification daemon, as defined in
571 the Desktop Notification Specification. To actually display the
572 notifications, notification-daemon is required.
573 See http://www.galago-project.org/specs/notification/.
576 Send an E-mail with the notification message to the configured
580 Submit notifications as passive check results to a local nagios instance.
583 Execute a program or script to handle the notification.
584 See collectd-exec(5).
587 Writes the notification message to a file or STDOUT/STDERR.
590 Send the notification to a remote host to handle it somehow.
593 Notifications are propagated to plugins written in Perl as well.
594 See collectd-perl(5).
597 It's possible to implement notification plugins in Python using the
598 python plugin. See collectd-python(5) for details.
600 * Value processing can be controlled using the "filter chain" infrastructure
601 and "matches" and "targets". The following plugins are available:
603 - match_empty_counter
604 Match counter values which are currently zero.
607 Match values using a hash function of the hostname.
610 Match values by their identifier based on regular expressions.
613 Match values with an invalid timestamp.
616 Select values by their data sources' values.
618 - target_notification
619 Create and dispatch a notification.
622 Replace parts of an identifier using regular expressions.
625 Scale (multiply) values by an arbitrary value.
628 Set (overwrite) entire parts of an identifier.
630 * Miscellaneous plugins:
633 Selects multiple value lists based on patterns or regular expressions
634 and creates new aggregated values lists from those.
637 Checks values against configured thresholds and creates notifications if
638 values are out of bounds. See collectd-threshold(5) for details.
641 Sets the hostname to a unique identifier. This is meant for setups
642 where each client may migrate to another physical host, possibly going
643 through one or more name changes in the process.
645 * Performance: Since collectd is running as a daemon it doesn't spend much
646 time starting up again and again. With the exception of the exec plugin no
647 processes are forked. Caching in output plugins, such as the rrdtool and
648 network plugins, makes sure your resources are used efficiently. Also,
649 since collectd is programmed multithreaded it benefits from hyper-threading
650 and multicore processors and makes sure that the daemon isn't idle if only
651 one plugin waits for an IO-operation to complete.
653 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
654 as possible and the default values should be okay for most users.
660 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
661 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
662 for a list of options and a syntax description.
664 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
665 files. The usual place for these files is beneath `/var/lib/collectd'.
667 * When using some of the plugins, collectd needs to run as user root, since
668 only root can do certain things, such as craft ICMP packages needed to ping
669 other hosts. collectd should NOT be installed setuid root since it can be
670 used to overwrite valuable files!
672 * Sample scripts to generate graphs reside in `contrib/' in the source
673 package or somewhere near `/usr/share/doc/collectd' in most distributions.
674 Please be aware that those script are meant as a starting point for your
675 own experiments.. Some of them require the `RRDs' Perl module.
676 (`librrds-perl' on Debian) If you have written a more sophisticated
677 solution please share it with us.
679 * The RRAs of the automatically created RRD files depend on the `step'
680 and `heartbeat' settings given. If change these settings you may need to
681 re-create the files, losing all data. Please be aware of that when changing
682 the values and read the rrdtool(1) manpage thoroughly.
685 collectd and chkrootkit
686 -----------------------
688 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
689 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
690 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
691 this case, collectd is a legitimate sniffer and the report should be
692 considered to be a false positive. However, you might want to check that
693 this really is collectd and not some other, illegitimate sniffer.
699 To compile collectd from source you will need:
701 * Usual suspects: C compiler, linker, preprocessor, make, ...
703 collectd makes use of some common C99 features, e.g. compound literals and
704 mixed declarations, and therefore requires a C99 compatible compiler.
706 On Debian and Ubuntu, the "build-essential" package should pull in
707 everything that's necessary.
709 * A POSIX-threads (pthread) implementation.
710 Since gathering some statistics is slow (network connections, slow devices,
711 etc) collectd is parallelized. The POSIX threads interface is being
712 used and should be found in various implementations for hopefully all
715 * When building from the Git repository, flex (tokenizer) and bison (parser
716 generator) are required. Release tarballs include the generated files – you
717 don't need these packages in that case.
719 * aerotools-ng (optional)
720 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
721 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
722 nor does it feature an installation routine. Therefore, you need to point
723 collectd's configure script at the source directory of the `aerotools-ng'
725 <https://github.com/lynix/aerotools-ng>
727 * CoreFoundation.framework and IOKit.framework (optional)
728 For compiling on Darwin in general and the `apple_sensors' plugin in
730 <http://developer.apple.com/corefoundation/>
732 * libatasmart (optional)
733 Used by the `smart' plugin.
734 <http://git.0pointer.de/?p=libatasmart.git>
737 The `turbostat' plugin can optionally build Linux Capabilities support,
738 which avoids full privileges requirement (aka. running as root) to read
740 <http://sites.google.com/site/fullycapable/>
742 * libclntsh (optional)
743 Used by the `oracle' plugin.
745 * libhiredis (optional)
746 Used by the redis plugin. Please note that you require a 0.10.0 version
747 or higher. <https://github.com/redis/hiredis>
750 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
751 `curl_xml', `nginx', or `write_http' plugin.
752 <http://curl.haxx.se/>
755 Used by the `dbi' plugin to connect to various databases.
756 <http://libdbi.sourceforge.net/>
758 * libesmtp (optional)
759 For the `notify_email' plugin.
760 <http://www.stafford.uklinux.net/libesmtp/>
762 * libganglia (optional)
763 Used by the `gmond' plugin to process data received from Ganglia.
764 <http://ganglia.info/>
767 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
771 * libgcrypt (optional)
772 Used by the `network' plugin for encryption and authentication.
773 <http://www.gnupg.org/>
776 Used by the `gps' plugin.
777 <http://developer.berlios.de/projects/gpsd/>
779 * libi2c-dev (optional)
780 Used for the plugin `barometer', provides just the i2c-dev.h header file
781 for user space i2c development.
784 For querying iptables counters.
785 <http://netfilter.org/>
787 * libjevents (optional)
788 The jevents library is used by the `intel_pmu' plugin to access the Linux
789 kernel perf interface.
790 Note: the library should be build with -fPIC flag to be linked with
791 intel_pmu shared object correctly.
792 <https://github.com/andikleen/pmu-tools>
795 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
796 used by the `java' plugin to execute Java bytecode.
797 See docs/BUILD.java.md for detailed build instructions.
798 <http://openjdk.java.net/> (and others)
801 Used by the `openldap' plugin.
802 <http://www.openldap.org/>
805 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
806 <https://www.lua.org/>
809 Used by the `lvm' plugin.
810 <ftp://sources.redhat.com/pub/lvm2/>
812 * libmemcached (optional)
813 Used by the `memcachec' plugin to connect to a memcache daemon.
814 <http://tangent.org/552/libmemcached.html>
816 * libmicrohttpd (optional)
817 Used by the write_prometheus plugin to run an http daemon.
818 <http://www.gnu.org/software/libmicrohttpd/>
821 Used by the `netlink' plugin.
822 <http://www.netfilter.org/projects/libmnl/>
824 * libmodbus (optional)
825 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
826 `modbus' plugin works with version 2.0.3 of the library – due to frequent
827 API changes other versions may or may not compile cleanly.
828 <http://www.libmodbus.org/>
830 * libmysqlclient (optional)
831 Unsurprisingly used by the `mysql' plugin.
832 <http://dev.mysql.com/>
834 * libnetapp (optional)
835 Required for the `netapp' plugin.
836 This library is part of the “Manage ONTAP SDK” published by NetApp.
838 * libnetsnmp (optional)
839 For the `snmp' plugin.
840 <http://www.net-snmp.org/>
842 * libnotify (optional)
843 For the `notify_desktop' plugin.
844 <http://www.galago-project.org/>
846 * libopenipmi (optional)
847 Used by the `ipmi' plugin to prove IPMI devices.
848 <http://openipmi.sourceforge.net/>
850 * liboping (optional)
851 Used by the `ping' plugin to send and receive ICMP packets.
852 <http://octo.it/liboping/>
854 * libowcapi (optional)
855 Used by the `onewire' plugin to read values from onewire sensors (or the
857 <http://www.owfs.org/>
860 Used to capture packets by the `dns' plugin.
861 <http://www.tcpdump.org/>
863 * libperfstat (optional)
864 Used by various plugins to gather statistics under AIX.
867 Obviously used by the `perl' plugin. The library has to be compiled with
868 ithread support (introduced in Perl 5.6.0).
869 <http://www.perl.org/>
872 The PostgreSQL C client library used by the `postgresql' plugin.
873 <http://www.postgresql.org/>
876 The PQoS library for Intel(R) Resource Director Technology used by the
878 <https://github.com/01org/intel-cmt-cat>
880 * libprotobuf, protoc 3.0+ (optional)
881 Used by the `grpc' plugin to generate service stubs and code to handle
882 network packets of collectd's protobuf-based network protocol.
883 <https://developers.google.com/protocol-buffers/>
885 * libprotobuf-c, protoc-c (optional)
886 Used by the `pinba' plugin to generate a parser for the network packets
887 sent by the Pinba PHP extension.
888 <http://code.google.com/p/protobuf-c/>
890 * libpython (optional)
891 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
893 <http://www.python.org/>
895 * librabbitmq (optional; also called “rabbitmq-c”)
896 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
897 <http://hg.rabbitmq.com/rabbitmq-c/>
899 * librdkafka (optional; also called “rdkafka”)
900 Used by the `write_kafka' plugin for producing messages and sending them
902 <https://github.com/edenhill/librdkafka>
904 * librouteros (optional)
905 Used by the `routeros' plugin to connect to a device running `RouterOS'.
906 <http://octo.it/librouteros/>
909 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
910 client support which was added after version 1.3 of RRDtool. Versions 1.0,
911 1.2 and 1.3 are known to work with the `rrdtool' plugin.
912 <http://oss.oetiker.ch/rrdtool/>
914 * librt, libsocket, libkstat, libdevinfo (optional)
915 Various standard Solaris libraries which provide system functions.
916 <http://developers.sun.com/solaris/>
918 * libsensors (optional)
919 To read from `lm_sensors', see the `sensors' plugin.
920 <http://www.lm-sensors.org/>
922 * libsigrok (optional)
923 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
924 libzip, and optionally (depending on which drivers are enabled) on
925 libusb, libftdi and libudev.
927 * libstatgrab (optional)
928 Used by various plugins to collect statistics on systems other than Linux
930 <http://www.i-scream.org/libstatgrab/>
932 * libtokyotyrant (optional)
933 Used by the `tokyotyrant' plugin.
934 <http://1978th.net/tokyotyrant/>
936 * libupsclient/nut (optional)
937 For the `nut' plugin which queries nut's `upsd'.
938 <http://networkupstools.org/>
941 Collect statistics from virtual machines.
942 <http://libvirt.org/>
945 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
947 <http://xmlsoft.org/>
950 Used by the `xencpu' plugin.
951 <http://xenbits.xensource.com/>
954 <http://www.xmms.org/>
957 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
958 'ovs_stats' and `log_logstash' plugins.
959 <http://github.com/lloyd/yajl>
961 * libvarnish (optional)
962 Fetches statistics from a Varnish instance. This is needed for the
964 <http://varnish-cache.org>
966 * riemann-c-client (optional)
967 For the `write_riemann' plugin.
968 <https://github.com/algernon/riemann-c-client>
970 Configuring / Compiling / Installing
971 ------------------------------------
973 To configure, build and install collectd with the default settings, run
974 `./configure && make && make install'. For detailed, generic instructions
975 see INSTALL. For a complete list of configure options and their description,
976 run `./configure --help'.
978 By default, the configure script will check for all build dependencies and
979 disable all plugins whose requirements cannot be fulfilled (any other plugin
980 will be enabled). To enable a plugin, install missing dependencies (see
981 section `Prerequisites' above) and rerun `configure'. If you specify the
982 `--enable-<plugin>' configure option, the script will fail if the depen-
983 dencies for the specified plugin are not met. In that case you can force the
984 plugin to be built using the `--enable-<plugin>=force' configure option.
985 This will most likely fail though unless you're working in a very unusual
986 setup and you really know what you're doing. If you specify the
987 `--disable-<plugin>' configure option, the plugin will not be built. If you
988 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
989 options, all plugins will be enabled or disabled respectively by default.
990 Explicitly enabling or disabling a plugin overwrites the default for the
991 specified plugin. These options are meant for package maintainers and should
992 not be used in everyday situations.
994 By default, collectd will be installed into `/opt/collectd'. You can adjust
995 this setting by specifying the `--prefix' configure option - see INSTALL for
996 details. If you pass DESTDIR=<path> to `make install', <path> will be
997 prefixed to all installation directories. This might be useful when creating
998 packages for collectd.
1000 Generating the configure script
1001 -------------------------------
1003 Collectd ships with a `build.sh' script to generate the `configure'
1004 script shipped with releases.
1006 To generate the `configure` script, you'll need the following dependencies:
1015 The `build.sh' script takes no arguments.
1021 To compile correctly collectd needs to be able to initialize static
1022 variables to NAN (Not A Number). Some C libraries, especially the GNU
1023 libc, have a problem with that.
1025 Luckily, with GCC it's possible to work around that problem: One can define
1026 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1027 ``implementation'' the configure script needs to compile and run a short
1028 test program. Obviously running a test program when doing a cross-
1029 compilation is, well, challenging.
1031 If you run into this problem, you can use the `--with-nan-emulation'
1032 configure option to force the use of this implementation. We can't promise
1033 that the compiled binary actually behaves as it should, but since NANs
1034 are likely never passed to the libm you have a good chance to be lucky.
1036 Likewise, collectd needs to know the layout of doubles in memory, in order
1037 to craft uniform network packets over different architectures. For this, it
1038 needs to know how to convert doubles into the memory layout used by x86. The
1039 configure script tries to figure this out by compiling and running a few
1040 small test programs. This is of course not possible when cross-compiling.
1041 You can use the `--with-fp-layout' option to tell the configure script which
1042 conversion method to assume. Valid arguments are:
1044 * `nothing' (12345678 -> 12345678)
1045 * `endianflip' (12345678 -> 87654321)
1046 * `intswap' (12345678 -> 56781234)
1052 Please use GitHub to report bugs and submit pull requests:
1053 <https://github.com/collectd/collectd/>.
1054 See CONTRIBUTING.md for details.
1056 For questions, development information and basically all other concerns please
1057 send an email to collectd's mailing list at
1058 <list at collectd.org>.
1060 For live discussion and more personal contact visit us in IRC, we're in
1061 channel #collectd on freenode.
1067 Florian octo Forster <octo at collectd.org>,
1068 Sebastian tokkee Harl <sh at tokkee.org>,
1069 and many contributors (see `AUTHORS').
projects / collectd.git / blob