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