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 Receives and handles queries from SNMP master agent and returns the data
507 collected by read plugins. Handles requests only for OIDs specified in
508 configuration file. To handle SNMP queries the plugin gets data from
509 collectd and translates requested values from collectd's internal format
513 One can query the values from the unixsock plugin whenever they're
514 needed. Please read collectd-unixsock(5) for a description on how that's
518 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
519 can be configured to avoid logging send errors (especially useful when
523 Sends the values collected by collectd to a web-server using HTTP POST
524 requests. The transmitted data is either in a form understood by the
525 Exec plugin or formatted in JSON.
528 Sends data to Apache Kafka, a distributed queue.
531 Writes data to the log
534 Sends data to MongoDB, a NoSQL database.
537 Publish values using an embedded HTTP server, in a format compatible
538 with Prometheus' collectd_exporter.
541 Sends the values to a Redis key-value database server.
544 Sends data to Riemann, a stream processing and monitoring system.
547 Sends data to Sensu, a stream processing and monitoring system, via the
548 Sensu client local TCP socket.
551 Sends data OpenTSDB, a scalable no master, no shared state time series
554 * Logging is, as everything in collectd, provided by plugins. The following
555 plugins keep us informed about what's going on:
558 Writes log messages to a file or STDOUT/STDERR.
561 Log messages are propagated to plugins written in Perl as well.
562 See collectd-perl(5).
565 It's possible to implement log plugins in Python using the python plugin.
566 See collectd-python(5) for details.
569 Logs to the standard UNIX logging mechanism, syslog.
572 Writes log messages formatted as logstash JSON events.
574 * Notifications can be handled by the following plugins:
577 Send a desktop notification to a notification daemon, as defined in
578 the Desktop Notification Specification. To actually display the
579 notifications, notification-daemon is required.
580 See http://www.galago-project.org/specs/notification/.
583 Send an E-mail with the notification message to the configured
587 Submit notifications as passive check results to a local nagios instance.
590 Execute a program or script to handle the notification.
591 See collectd-exec(5).
594 Writes the notification message to a file or STDOUT/STDERR.
597 Send the notification to a remote host to handle it somehow.
600 Notifications are propagated to plugins written in Perl as well.
601 See collectd-perl(5).
604 It's possible to implement notification plugins in Python using the
605 python plugin. See collectd-python(5) for details.
607 * Value processing can be controlled using the "filter chain" infrastructure
608 and "matches" and "targets". The following plugins are available:
610 - match_empty_counter
611 Match counter values which are currently zero.
614 Match values using a hash function of the hostname.
617 Match values by their identifier based on regular expressions.
620 Match values with an invalid timestamp.
623 Select values by their data sources' values.
625 - target_notification
626 Create and dispatch a notification.
629 Replace parts of an identifier using regular expressions.
632 Scale (multiply) values by an arbitrary value.
635 Set (overwrite) entire parts of an identifier.
637 * Miscellaneous plugins:
640 Selects multiple value lists based on patterns or regular expressions
641 and creates new aggregated values lists from those.
644 Checks values against configured thresholds and creates notifications if
645 values are out of bounds. See collectd-threshold(5) for details.
648 Sets the hostname to a unique identifier. This is meant for setups
649 where each client may migrate to another physical host, possibly going
650 through one or more name changes in the process.
652 * Performance: Since collectd is running as a daemon it doesn't spend much
653 time starting up again and again. With the exception of the exec plugin no
654 processes are forked. Caching in output plugins, such as the rrdtool and
655 network plugins, makes sure your resources are used efficiently. Also,
656 since collectd is programmed multithreaded it benefits from hyper-threading
657 and multicore processors and makes sure that the daemon isn't idle if only
658 one plugin waits for an IO-operation to complete.
660 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
661 as possible and the default values should be okay for most users.
667 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
668 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
669 for a list of options and a syntax description.
671 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
672 files. The usual place for these files is beneath `/var/lib/collectd'.
674 * When using some of the plugins, collectd needs to run as user root, since
675 only root can do certain things, such as craft ICMP packages needed to ping
676 other hosts. collectd should NOT be installed setuid root since it can be
677 used to overwrite valuable files!
679 * Sample scripts to generate graphs reside in `contrib/' in the source
680 package or somewhere near `/usr/share/doc/collectd' in most distributions.
681 Please be aware that those script are meant as a starting point for your
682 own experiments.. Some of them require the `RRDs' Perl module.
683 (`librrds-perl' on Debian) If you have written a more sophisticated
684 solution please share it with us.
686 * The RRAs of the automatically created RRD files depend on the `step'
687 and `heartbeat' settings given. If change these settings you may need to
688 re-create the files, losing all data. Please be aware of that when changing
689 the values and read the rrdtool(1) manpage thoroughly.
692 collectd and chkrootkit
693 -----------------------
695 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
696 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
697 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
698 this case, collectd is a legitimate sniffer and the report should be
699 considered to be a false positive. However, you might want to check that
700 this really is collectd and not some other, illegitimate sniffer.
706 To compile collectd from source you will need:
708 * Usual suspects: C compiler, linker, preprocessor, make, ...
710 collectd makes use of some common C99 features, e.g. compound literals and
711 mixed declarations, and therefore requires a C99 compatible compiler.
713 On Debian and Ubuntu, the "build-essential" package should pull in
714 everything that's necessary.
716 * A POSIX-threads (pthread) implementation.
717 Since gathering some statistics is slow (network connections, slow devices,
718 etc) collectd is parallelized. The POSIX threads interface is being
719 used and should be found in various implementations for hopefully all
722 * When building from the Git repository, flex (tokenizer) and bison (parser
723 generator) are required. Release tarballs include the generated files – you
724 don't need these packages in that case.
726 * aerotools-ng (optional)
727 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
728 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
729 nor does it feature an installation routine. Therefore, you need to point
730 collectd's configure script at the source directory of the `aerotools-ng'
732 <https://github.com/lynix/aerotools-ng>
734 * CoreFoundation.framework and IOKit.framework (optional)
735 For compiling on Darwin in general and the `apple_sensors' plugin in
737 <http://developer.apple.com/corefoundation/>
739 * libatasmart (optional)
740 Used by the `smart' plugin.
741 <http://git.0pointer.de/?p=libatasmart.git>
744 The `turbostat' plugin can optionally build Linux Capabilities support,
745 which avoids full privileges requirement (aka. running as root) to read
747 <http://sites.google.com/site/fullycapable/>
749 * libclntsh (optional)
750 Used by the `oracle' plugin.
752 * libhiredis (optional)
753 Used by the redis plugin. Please note that you require a 0.10.0 version
754 or higher. <https://github.com/redis/hiredis>
757 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
758 `curl_xml', `nginx', or `write_http' plugin.
759 <http://curl.haxx.se/>
762 Used by the `dbi' plugin to connect to various databases.
763 <http://libdbi.sourceforge.net/>
765 * libesmtp (optional)
766 For the `notify_email' plugin.
767 <http://www.stafford.uklinux.net/libesmtp/>
769 * libganglia (optional)
770 Used by the `gmond' plugin to process data received from Ganglia.
771 <http://ganglia.info/>
774 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
778 * libgcrypt (optional)
779 Used by the `network' plugin for encryption and authentication.
780 <http://www.gnupg.org/>
783 Used by the `gps' plugin.
784 <http://developer.berlios.de/projects/gpsd/>
786 * libi2c-dev (optional)
787 Used for the plugin `barometer', provides just the i2c-dev.h header file
788 for user space i2c development.
791 For querying iptables counters.
792 <http://netfilter.org/>
794 * libjevents (optional)
795 The jevents library is used by the `intel_pmu' plugin to access the Linux
796 kernel perf interface.
797 Note: the library should be build with -fPIC flag to be linked with
798 intel_pmu shared object correctly.
799 <https://github.com/andikleen/pmu-tools>
802 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
803 used by the `java' plugin to execute Java bytecode.
804 See docs/BUILD.java.md for detailed build instructions.
805 <http://openjdk.java.net/> (and others)
808 Used by the `openldap' plugin.
809 <http://www.openldap.org/>
812 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
813 <https://www.lua.org/>
816 Used by the `lvm' plugin.
817 <ftp://sources.redhat.com/pub/lvm2/>
819 * libmemcached (optional)
820 Used by the `memcachec' plugin to connect to a memcache daemon.
821 <http://tangent.org/552/libmemcached.html>
823 * libmicrohttpd (optional)
824 Used by the write_prometheus plugin to run an http daemon.
825 <http://www.gnu.org/software/libmicrohttpd/>
828 Used by the `netlink' plugin.
829 <http://www.netfilter.org/projects/libmnl/>
831 * libmodbus (optional)
832 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
833 `modbus' plugin works with version 2.0.3 of the library – due to frequent
834 API changes other versions may or may not compile cleanly.
835 <http://www.libmodbus.org/>
837 * libmysqlclient (optional)
838 Unsurprisingly used by the `mysql' plugin.
839 <http://dev.mysql.com/>
841 * libnetapp (optional)
842 Required for the `netapp' plugin.
843 This library is part of the “Manage ONTAP SDK” published by NetApp.
845 * libnetsnmp (optional)
846 For the `snmp' and 'snmp_agent' plugins.
847 <http://www.net-snmp.org/>
849 * libnetsnmpagent (optional)
850 Required for the 'snmp_agent' plugin.
851 <http://www.net-snmp.org/>
853 * libnotify (optional)
854 For the `notify_desktop' plugin.
855 <http://www.galago-project.org/>
857 * libopenipmi (optional)
858 Used by the `ipmi' plugin to prove IPMI devices.
859 <http://openipmi.sourceforge.net/>
861 * liboping (optional)
862 Used by the `ping' plugin to send and receive ICMP packets.
863 <http://octo.it/liboping/>
865 * libowcapi (optional)
866 Used by the `onewire' plugin to read values from onewire sensors (or the
868 <http://www.owfs.org/>
871 Used to capture packets by the `dns' plugin.
872 <http://www.tcpdump.org/>
874 * libperfstat (optional)
875 Used by various plugins to gather statistics under AIX.
878 Obviously used by the `perl' plugin. The library has to be compiled with
879 ithread support (introduced in Perl 5.6.0).
880 <http://www.perl.org/>
883 The PostgreSQL C client library used by the `postgresql' plugin.
884 <http://www.postgresql.org/>
887 The PQoS library for Intel(R) Resource Director Technology used by the
889 <https://github.com/01org/intel-cmt-cat>
891 * libprotobuf, protoc 3.0+ (optional)
892 Used by the `grpc' plugin to generate service stubs and code to handle
893 network packets of collectd's protobuf-based network protocol.
894 <https://developers.google.com/protocol-buffers/>
896 * libprotobuf-c, protoc-c (optional)
897 Used by the `pinba' plugin to generate a parser for the network packets
898 sent by the Pinba PHP extension.
899 <http://code.google.com/p/protobuf-c/>
901 * libpython (optional)
902 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
904 <http://www.python.org/>
906 * librabbitmq (optional; also called “rabbitmq-c”)
907 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
908 <http://hg.rabbitmq.com/rabbitmq-c/>
910 * librdkafka (optional; also called “rdkafka”)
911 Used by the `write_kafka' plugin for producing messages and sending them
913 <https://github.com/edenhill/librdkafka>
915 * librouteros (optional)
916 Used by the `routeros' plugin to connect to a device running `RouterOS'.
917 <http://octo.it/librouteros/>
920 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
921 client support which was added after version 1.3 of RRDtool. Versions 1.0,
922 1.2 and 1.3 are known to work with the `rrdtool' plugin.
923 <http://oss.oetiker.ch/rrdtool/>
925 * librt, libsocket, libkstat, libdevinfo (optional)
926 Various standard Solaris libraries which provide system functions.
927 <http://developers.sun.com/solaris/>
929 * libsensors (optional)
930 To read from `lm_sensors', see the `sensors' plugin.
931 <http://www.lm-sensors.org/>
933 * libsigrok (optional)
934 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
935 libzip, and optionally (depending on which drivers are enabled) on
936 libusb, libftdi and libudev.
938 * libstatgrab (optional)
939 Used by various plugins to collect statistics on systems other than Linux
941 <http://www.i-scream.org/libstatgrab/>
943 * libtokyotyrant (optional)
944 Used by the `tokyotyrant' plugin.
945 <http://1978th.net/tokyotyrant/>
947 * libupsclient/nut (optional)
948 For the `nut' plugin which queries nut's `upsd'.
949 <http://networkupstools.org/>
952 Collect statistics from virtual machines.
953 <http://libvirt.org/>
956 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
958 <http://xmlsoft.org/>
961 Used by the `xencpu' plugin.
962 <http://xenbits.xensource.com/>
965 <http://www.xmms.org/>
968 Parse JSON data. This is needed for the `ceph', `curl_json', 'ovs_events',
969 'ovs_stats' and `log_logstash' plugins.
970 <http://github.com/lloyd/yajl>
972 * libvarnish (optional)
973 Fetches statistics from a Varnish instance. This is needed for the
975 <http://varnish-cache.org>
977 * riemann-c-client (optional)
978 For the `write_riemann' plugin.
979 <https://github.com/algernon/riemann-c-client>
981 Configuring / Compiling / Installing
982 ------------------------------------
984 To configure, build and install collectd with the default settings, run
985 `./configure && make && make install'. For detailed, generic instructions
986 see INSTALL. For a complete list of configure options and their description,
987 run `./configure --help'.
989 By default, the configure script will check for all build dependencies and
990 disable all plugins whose requirements cannot be fulfilled (any other plugin
991 will be enabled). To enable a plugin, install missing dependencies (see
992 section `Prerequisites' above) and rerun `configure'. If you specify the
993 `--enable-<plugin>' configure option, the script will fail if the depen-
994 dencies for the specified plugin are not met. In that case you can force the
995 plugin to be built using the `--enable-<plugin>=force' configure option.
996 This will most likely fail though unless you're working in a very unusual
997 setup and you really know what you're doing. If you specify the
998 `--disable-<plugin>' configure option, the plugin will not be built. If you
999 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
1000 options, all plugins will be enabled or disabled respectively by default.
1001 Explicitly enabling or disabling a plugin overwrites the default for the
1002 specified plugin. These options are meant for package maintainers and should
1003 not be used in everyday situations.
1005 By default, collectd will be installed into `/opt/collectd'. You can adjust
1006 this setting by specifying the `--prefix' configure option - see INSTALL for
1007 details. If you pass DESTDIR=<path> to `make install', <path> will be
1008 prefixed to all installation directories. This might be useful when creating
1009 packages for collectd.
1011 Generating the configure script
1012 -------------------------------
1014 Collectd ships with a `build.sh' script to generate the `configure'
1015 script shipped with releases.
1017 To generate the `configure` script, you'll need the following dependencies:
1026 The `build.sh' script takes no arguments.
1032 To compile correctly collectd needs to be able to initialize static
1033 variables to NAN (Not A Number). Some C libraries, especially the GNU
1034 libc, have a problem with that.
1036 Luckily, with GCC it's possible to work around that problem: One can define
1037 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
1038 ``implementation'' the configure script needs to compile and run a short
1039 test program. Obviously running a test program when doing a cross-
1040 compilation is, well, challenging.
1042 If you run into this problem, you can use the `--with-nan-emulation'
1043 configure option to force the use of this implementation. We can't promise
1044 that the compiled binary actually behaves as it should, but since NANs
1045 are likely never passed to the libm you have a good chance to be lucky.
1047 Likewise, collectd needs to know the layout of doubles in memory, in order
1048 to craft uniform network packets over different architectures. For this, it
1049 needs to know how to convert doubles into the memory layout used by x86. The
1050 configure script tries to figure this out by compiling and running a few
1051 small test programs. This is of course not possible when cross-compiling.
1052 You can use the `--with-fp-layout' option to tell the configure script which
1053 conversion method to assume. Valid arguments are:
1055 * `nothing' (12345678 -> 12345678)
1056 * `endianflip' (12345678 -> 87654321)
1057 * `intswap' (12345678 -> 56781234)
1063 Please use GitHub to report bugs and submit pull requests:
1064 <https://github.com/collectd/collectd/>.
1065 See CONTRIBUTING.md for details.
1067 For questions, development information and basically all other concerns please
1068 send an email to collectd's mailing list at
1069 <list at collectd.org>.
1071 For live discussion and more personal contact visit us in IRC, we're in
1072 channel #collectd on freenode.
1078 Florian octo Forster <octo at collectd.org>,
1079 Sebastian tokkee Harl <sh at tokkee.org>,
1080 and many contributors (see `AUTHORS').
projects / collectd.git / blob