4fa641de162b3fe91d7f0ed13b410773ac0a34e1
1 collectd - System information collection daemon
2 =================================================
3 https://collectd.org/
5 About
6 -----
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
10 ways.
13 Features
14 --------
16 * collectd is able to collect the following data:
18 - apache
19 Apache server utilization: Number of bytes transferred, number of
20 requests handled and detailed scoreboard statistics
22 - apcups
23 APC UPS Daemon: UPS charge, load, input/output/battery voltage, etc.
25 - apple_sensors
26 Sensors in Macs running Mac OS X / Darwin: Temperature, fan speed and
27 voltage sensors.
29 - aquaero
30 Various sensors in the Aquaero 5 water cooling board made by Aquacomputer.
32 - ascent
33 Statistics about Ascent, a free server for the game `World of Warcraft'.
35 - barometer
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.
40 - battery
41 Batterycharge, -current and voltage of ACPI and PMU based laptop
42 batteries.
44 - bind
45 Name server and resolver statistics from the `statistics-channel'
46 interface of BIND 9.5, 9,6 and later.
48 - ceph
49 Statistics from the Ceph distributed storage system.
51 - cgroups
52 CPU accounting information for process groups under Linux.
54 - chrony
55 Chrony daemon statistics: Local clock drift, offset to peers, etc.
57 - conntrack
58 Number of nf_conntrack entries.
60 - contextswitch
61 Number of context switches done by the operating system.
63 - cpu
64 CPU utilization: Time spent in the system, user, nice, idle, and related
65 states.
67 - cpufreq
68 CPU frequency (For laptops with speed step or a similar technology)
70 - cpusleep
71 CPU sleep: Time spent in suspend (For mobile devices which enter suspend automatically)
73 - curl
74 Parse statistics from websites using regular expressions.
76 - curl_json
77 Retrieves JSON data via cURL and parses it according to user
78 configuration.
80 - curl_xml
81 Retrieves XML data via cURL and parses it according to user
82 configuration.
84 - dbi
85 Executes SQL statements on various databases and interprets the returned
86 data.
88 - df
89 Mountpoint usage (Basically the values `df(1)' delivers)
91 - disk
92 Disk utilization: Sectors read/written, number of read/write actions,
93 average time an IO-operation took to complete.
95 - dns
96 DNS traffic: Query types, response codes, opcodes and traffic/octets
97 transferred.
99 - dpdk
100 Collect DPDK interface statistics.
101 See docs/BUILD.dpdkstat.md for detailed build instructions.
103 - drbd
104 Collect individual drbd resource statistics.
106 - email
107 Email statistics: Count, traffic, spam scores and checks.
108 See collectd-email(5).
110 - entropy
111 Amount of entropy available to the system.
113 - ethstat
114 Network interface card statistics.
116 - exec
117 Values gathered by a custom program or script.
118 See collectd-exec(5).
120 - fhcount
121 File handles statistics.
123 - filecount
124 Count the number of files in directories.
126 - fscache
127 Linux file-system based caching framework statistics.
129 - gmond
130 Receive multicast traffic from Ganglia instances.
132 - gps
133 Monitor gps related data through gpsd.
135 - grpc
136 Send and receive values over the network using the gRPC framework.
138 - hddtemp
139 Hard disk temperatures using hddtempd.
141 - hugepages
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 - interface
147 Interface traffic: Number of octets, packets and errors for each
148 interface.
150 - ipc
151 IPC counters: semaphores used, number of allocated segments in shared
152 memory and more.
154 - ipmi
155 IPMI (Intelligent Platform Management Interface) sensors information.
157 - iptables
158 Iptables' counters: Number of bytes that were matched by a certain
159 iptables rule.
161 - ipvs
162 IPVS connection statistics (number of connections, octets and packets
163 for each service and destination).
164 See http://www.linuxvirtualserver.org/software/index.html.
166 - irq
167 IRQ counters: Frequency in which certain interrupts occur.
169 - java
170 Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java
171 bytecode.
172 See docs/BUILD.java.md for detailed build instructions.
174 - load
175 System load average over the last 1, 5 and 15 minutes.
177 - lpar
178 Detailed CPU statistics of the “Logical Partitions” virtualization
179 technique built into IBM's POWER processors.
181 - lua
182 The Lua plugin implements a Lua interpreter into collectd. This
183 makes it possible to write plugins in Lua which are executed by
184 collectd without the need to start a heavy interpreter every interval.
185 See collectd-lua(5) for details.
187 - lvm
188 Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux'
189 “Logical Volume Manager” (LVM).
191 - madwifi
192 Queries very detailed usage statistics from wireless LAN adapters and
193 interfaces that use the Atheros chipset and the MadWifi driver.
195 - mbmon
196 Motherboard sensors: temperature, fan speed and voltage information,
197 using mbmon(1).
199 - md
200 Linux software-RAID device information (number of active, failed, spare
201 and missing disks).
203 - memcachec
204 Query and parse data from a memcache daemon (memcached).
206 - memcached
207 Statistics of the memcached distributed caching system.
208 <http://www.danga.com/memcached/>
210 - memory
211 Memory utilization: Memory occupied by running processes, page cache,
212 buffer cache and free.
214 - mic
215 Collects CPU usage, memory usage, temperatures and power consumption from
216 Intel Many Integrated Core (MIC) CPUs.
218 - modbus
219 Reads values from Modbus/TCP enabled devices. Supports reading values
220 from multiple "slaves" so gateway devices can be used.
222 - mqtt
223 Publishes and subscribes to MQTT topics.
225 - multimeter
226 Information provided by serial multimeters, such as the `Metex
227 M-4650CR'.
229 - mysql
230 MySQL server statistics: Commands issued, handlers triggered, thread
231 usage, query cache utilization and traffic/octets sent and received.
233 - netapp
234 Plugin to query performance values from a NetApp storage system using the
235 “Manage ONTAP” SDK provided by NetApp.
237 - netlink
238 Very detailed Linux network interface and routing statistics. You can get
239 (detailed) information on interfaces, qdiscs, classes, and, if you can
240 make use of it, filters.
242 - network
243 Receive values that were collected by other hosts. Large setups will
244 want to collect the data on one dedicated machine, and this is the
245 plugin of choice for that.
247 - nfs
248 NFS Procedures: Which NFS command were called how often. Only NFSv2 and
249 NFSv3 right now.
251 - nginx
252 Collects statistics from `nginx' (speak: engine X), a HTTP and mail
253 server/proxy.
255 - ntpd
256 NTP daemon statistics: Local clock drift, offset to peers, etc.
258 - numa
259 Information about Non-Uniform Memory Access (NUMA).
261 - nut
262 Network UPS tools: UPS current, voltage, power, charge, utilisation,
263 temperature, etc. See upsd(8).
265 - olsrd
266 Queries routing information from the “Optimized Link State Routing”
267 daemon.
269 - onewire (EXPERIMENTAL!)
270 Read onewire sensors using the owcapu library of the owfs project.
271 Please read in collectd.conf(5) why this plugin is experimental.
273 - openldap
274 Read monitoring information from OpenLDAP's cn=Monitor subtree.
276 - openvpn
277 RX and TX of each client in openvpn-status.log (status-version 2).
278 <http://openvpn.net/index.php/documentation/howto.html>
280 - oracle
281 Query data from an Oracle database.
283 - perl
284 The perl plugin implements a Perl-interpreter into collectd. You can
285 write your own plugins in Perl and return arbitrary values using this
286 API. See collectd-perl(5).
288 - pf
289 Query statistics from BSD's packet filter "pf".
291 - pinba
292 Receive and dispatch timing values from Pinba, a profiling extension for
293 PHP.
295 - ping
296 Network latency: Time to reach the default gateway or another given
297 host.
299 - postgresql
300 PostgreSQL database statistics: active server connections, transaction
301 numbers, block IO, table row manipulations.
303 - powerdns
304 PowerDNS name server statistics.
306 - processes
307 Process counts: Number of running, sleeping, zombie, ... processes.
309 - protocols
310 Counts various aspects of network protocols such as IP, TCP, UDP, etc.
312 - python
313 The python plugin implements a Python interpreter into collectd. This
314 makes it possible to write plugins in Python which are executed by
315 collectd without the need to start a heavy interpreter every interval.
316 See collectd-python(5) for details.
318 - redis
319 The redis plugin gathers information from a Redis server, including:
320 uptime, used memory, total connections etc.
322 - routeros
323 Query interface and wireless registration statistics from RouterOS.
325 - rrdcached
326 RRDtool caching daemon (RRDcacheD) statistics.
328 - sensors
329 System sensors, accessed using lm_sensors: Voltages, temperatures and
330 fan rotation speeds.
332 - serial
333 RX and TX of serial interfaces. Linux only; needs root privileges.
335 - sigrok
336 Uses libsigrok as a backend, allowing any sigrok-supported device
337 to have its measurements fed to collectd. This includes multimeters,
338 sound level meters, thermometers, and much more.
340 - smart
341 Collect SMART statistics, notably load cycle count, temperature
342 and bad sectors.
344 - snmp
345 Read values from SNMP (Simple Network Management Protocol) enabled
346 network devices such as switches, routers, thermometers, rack monitoring
347 servers, etc. See collectd-snmp(5).
349 - statsd
350 Acts as a StatsD server, reading values sent over the network from StatsD
351 clients and calculating rates and other aggregates out of these values.
353 - swap
354 Pages swapped out onto hard disk or whatever is called `swap' by the OS..
356 - table
357 Parse table-like structured files.
359 - tail
360 Follows (tails) log files, parses them by lines and submits matched
361 values.
363 - tail_csv
364 Follows (tails) files in CSV format, parses each line and submits
365 extracted values.
367 - tape
368 Bytes and operations read and written on tape devices. Solaris only.
370 - tcpconns
371 Number of TCP connections to specific local and remote ports.
373 - teamspeak2
374 TeamSpeak2 server statistics.
376 - ted
377 Plugin to read values from `The Energy Detective' (TED).
379 - thermal
380 Linux ACPI thermal zone information.
382 - tokyotyrant
383 Reads the number of records and file size from a running Tokyo Tyrant
384 server.
386 - turbostat
387 Reads CPU frequency and C-state residency on modern Intel
388 turbo-capable processors.
390 - uptime
391 System uptime statistics.
393 - users
394 Users currently logged in.
396 - varnish
397 Various statistics from Varnish, an HTTP accelerator.
399 - virt
400 CPU, memory, disk and network I/O statistics from virtual machines.
402 - vmem
403 Virtual memory statistics, e. g. the number of page-ins/-outs or the
404 number of pagefaults.
406 - vserver
407 System resources used by Linux VServers.
408 See <http://linux-vserver.org/>.
410 - wireless
411 Link quality of wireless cards. Linux only.
413 - xencpu
414 XEN Hypervisor CPU stats.
416 - xmms
417 Bitrate and frequency of music played with XMMS.
419 - zfs_arc
420 Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
422 - zone
423 Measures the percentage of cpu load per container (zone) under Solaris 10
424 and higher
426 - zookeeper
427 Read data from Zookeeper's MNTR command.
429 * Output can be written or sent to various destinations by the following
430 plugins:
432 - amqp
433 Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
434 server, such as RabbitMQ.
436 - csv
437 Write to comma separated values (CSV) files. This needs lots of
438 diskspace but is extremely portable and can be analysed with almost
439 every program that can analyse anything. Even Microsoft's Excel..
441 - lua
442 It's possible to implement write plugins in Lua using the Lua
443 plugin. See collectd-lua(5) for details.
445 - network
446 Send the data to a remote host to save the data somehow. This is useful
447 for large setups where the data should be saved by a dedicated machine.
449 - perl
450 Of course the values are propagated to plugins written in Perl, too, so
451 you can easily do weird stuff with the plugins we didn't dare think of
452 ;) See collectd-perl(5).
454 - python
455 It's possible to implement write plugins in Python using the python
456 plugin. See collectd-python(5) for details.
458 - rrdcached
459 Output to round-robin-database (RRD) files using the RRDtool caching
460 daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
461 implementation of the caching done by the `rrdtool' plugin.
463 - rrdtool
464 Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
465 This is likely the most popular destination for such values. Since
466 updates to RRD-files are somewhat expensive this plugin can cache
467 updates to the files and write a bunch of updates at once, which lessens
468 system load a lot.
470 - unixsock
471 One can query the values from the unixsock plugin whenever they're
472 needed. Please read collectd-unixsock(5) for a description on how that's
473 done.
475 - write_graphite
476 Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
477 can be configured to avoid logging send errors (especially useful when
478 using UDP).
480 - write_http
481 Sends the values collected by collectd to a web-server using HTTP POST
482 requests. The transmitted data is either in a form understood by the
483 Exec plugin or formatted in JSON.
485 - write_kafka
486 Sends data to Apache Kafka, a distributed queue.
488 - write_log
489 Writes data to the log
491 - write_mongodb
492 Sends data to MongoDB, a NoSQL database.
494 - write_redis
495 Sends the values to a Redis key-value database server.
497 - write_riemann
498 Sends data to Riemann, a stream processing and monitoring system.
500 - write_sensu
501 Sends data to Sensu, a stream processing and monitoring system, via the
502 Sensu client local TCP socket.
504 - write_tsdb
505 Sends data OpenTSDB, a scalable no master, no shared state time series
506 database.
508 * Logging is, as everything in collectd, provided by plugins. The following
509 plugins keep us informed about what's going on:
511 - logfile
512 Writes log messages to a file or STDOUT/STDERR.
514 - perl
515 Log messages are propagated to plugins written in Perl as well.
516 See collectd-perl(5).
518 - python
519 It's possible to implement log plugins in Python using the python plugin.
520 See collectd-python(5) for details.
522 - syslog
523 Logs to the standard UNIX logging mechanism, syslog.
525 - log_logstash
526 Writes log messages formatted as logstash JSON events.
528 * Notifications can be handled by the following plugins:
530 - notify_desktop
531 Send a desktop notification to a notification daemon, as defined in
532 the Desktop Notification Specification. To actually display the
533 notifications, notification-daemon is required.
534 See http://www.galago-project.org/specs/notification/.
536 - notify_email
537 Send an E-mail with the notification message to the configured
538 recipients.
540 - notify_nagios
541 Submit notifications as passive check results to a local nagios instance.
543 - exec
544 Execute a program or script to handle the notification.
545 See collectd-exec(5).
547 - logfile
548 Writes the notification message to a file or STDOUT/STDERR.
550 - network
551 Send the notification to a remote host to handle it somehow.
553 - perl
554 Notifications are propagated to plugins written in Perl as well.
555 See collectd-perl(5).
557 - python
558 It's possible to implement notification plugins in Python using the
559 python plugin. See collectd-python(5) for details.
561 * Value processing can be controlled using the "filter chain" infrastructure
562 and "matches" and "targets". The following plugins are available:
564 - match_empty_counter
565 Match counter values which are currently zero.
567 - match_hashed
568 Match values using a hash function of the hostname.
570 - match_regex
571 Match values by their identifier based on regular expressions.
573 - match_timediff
574 Match values with an invalid timestamp.
576 - match_value
577 Select values by their data sources' values.
579 - target_notification
580 Create and dispatch a notification.
582 - target_replace
583 Replace parts of an identifier using regular expressions.
585 - target_scale
586 Scale (multiply) values by an arbitrary value.
588 - target_set
589 Set (overwrite) entire parts of an identifier.
591 * Miscellaneous plugins:
593 - aggregation
594 Selects multiple value lists based on patterns or regular expressions
595 and creates new aggregated values lists from those.
597 - threshold
598 Checks values against configured thresholds and creates notifications if
599 values are out of bounds. See collectd-threshold(5) for details.
601 - uuid
602 Sets the hostname to a unique identifier. This is meant for setups
603 where each client may migrate to another physical host, possibly going
604 through one or more name changes in the process.
606 * Performance: Since collectd is running as a daemon it doesn't spend much
607 time starting up again and again. With the exception of the exec plugin no
608 processes are forked. Caching in output plugins, such as the rrdtool and
609 network plugins, makes sure your resources are used efficiently. Also,
610 since collectd is programmed multithreaded it benefits from hyper-threading
611 and multicore processors and makes sure that the daemon isn't idle if only
612 one plugin waits for an IO-operation to complete.
614 * Once set up, hardly any maintenance is necessary. Setup is kept as easy
615 as possible and the default values should be okay for most users.
618 Operation
619 ---------
621 * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
622 Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
623 for a list of options and a syntax description.
625 * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
626 files. The usual place for these files is beneath `/var/lib/collectd'.
628 * When using some of the plugins, collectd needs to run as user root, since
629 only root can do certain things, such as craft ICMP packages needed to ping
630 other hosts. collectd should NOT be installed setuid root since it can be
631 used to overwrite valuable files!
633 * Sample scripts to generate graphs reside in `contrib/' in the source
634 package or somewhere near `/usr/share/doc/collectd' in most distributions.
635 Please be aware that those script are meant as a starting point for your
636 own experiments.. Some of them require the `RRDs' Perl module.
637 (`librrds-perl' on Debian) If you have written a more sophisticated
638 solution please share it with us.
640 * The RRAs of the automatically created RRD files depend on the `step'
641 and `heartbeat' settings given. If change these settings you may need to
642 re-create the files, losing all data. Please be aware of that when changing
643 the values and read the rrdtool(1) manpage thoroughly.
646 collectd and chkrootkit
647 -----------------------
649 If you are using the `dns' plugin chkrootkit(1) will report collectd as a
650 packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
651 plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
652 this case, collectd is a legitimate sniffer and the report should be
653 considered to be a false positive. However, you might want to check that
654 this really is collectd and not some other, illegitimate sniffer.
657 Prerequisites
658 -------------
660 To compile collectd from source you will need:
662 * Usual suspects: C compiler, linker, preprocessor, make, ...
664 * A POSIX-threads (pthread) implementation.
665 Since gathering some statistics is slow (network connections, slow devices,
666 etc) collectd is parallelized. The POSIX threads interface is being
667 used and should be found in various implementations for hopefully all
668 platforms.
670 * aerotools-ng (optional)
671 Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
672 is used by the `aerotools-ng' toolkit, is not compiled as a shared object
673 nor does it feature an installation routine. Therefore, you need to point
674 collectd's configure script at the source directory of the `aerotools-ng'
675 project.
676 <https://github.com/lynix/aerotools-ng>
678 * CoreFoundation.framework and IOKit.framework (optional)
679 For compiling on Darwin in general and the `apple_sensors' plugin in
680 particular.
681 <http://developer.apple.com/corefoundation/>
683 * libatasmart (optional)
684 Used by the `smart' plugin.
685 <http://git.0pointer.de/?p=libatasmart.git>
687 * libcap (optional)
688 The `turbostat' plugin can optionally build Linux Capabilities support,
689 which avoids full privileges requirement (aka. running as root) to read
690 values.
691 <http://sites.google.com/site/fullycapable/>
693 * libclntsh (optional)
694 Used by the `oracle' plugin.
696 * libhiredis (optional)
697 Used by the redis plugin. Please note that you require a 0.10.0 version
698 or higher. <https://github.com/redis/hiredis>
700 * libcurl (optional)
701 If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
702 `curl_xml', `nginx', or `write_http' plugin.
703 <http://curl.haxx.se/>
705 * libdbi (optional)
706 Used by the `dbi' plugin to connect to various databases.
707 <http://libdbi.sourceforge.net/>
709 * libesmtp (optional)
710 For the `notify_email' plugin.
711 <http://www.stafford.uklinux.net/libesmtp/>
713 * libganglia (optional)
714 Used by the `gmond' plugin to process data received from Ganglia.
715 <http://ganglia.info/>
717 * libgrpc (optional)
718 Used by the `grpc' plugin. gRPC requires a C++ compiler supporting the
719 C++11 standard.
720 <https://grpc.io/>
722 * libgcrypt (optional)
723 Used by the `network' plugin for encryption and authentication.
724 <http://www.gnupg.org/>
726 * libgps (optional)
727 Used by the `gps' plugin.
728 <http://developer.berlios.de/projects/gpsd/>
730 * libhal (optional)
731 If present, the `uuid' plugin will check for UUID from HAL.
732 <http://hal.freedesktop.org/>
734 * libi2c-dev (optional)
735 Used for the plugin `barometer', provides just the i2c-dev.h header file
736 for user space i2c development.
738 * libiptc (optional)
739 For querying iptables counters.
740 <http://netfilter.org/>
742 * libjvm (optional)
743 Library that encapsulates the `Java Virtual Machine' (JVM). This library is
744 used by the `java' plugin to execute Java bytecode.
745 See docs/BUILD.java.md for detailed build instructions.
746 <http://openjdk.java.net/> (and others)
748 * libldap (optional)
749 Used by the `openldap' plugin.
750 <http://www.openldap.org/>
752 * liblua (optional)
753 Used by the `lua' plugin. Currently, Lua 5.1 and later are supported.
754 <https://www.lua.org/>
756 * liblvm2 (optional)
757 Used by the `lvm' plugin.
758 <ftp://sources.redhat.com/pub/lvm2/>
760 * libmemcached (optional)
761 Used by the `memcachec' plugin to connect to a memcache daemon.
762 <http://tangent.org/552/libmemcached.html>
764 * libmnl (optional)
765 Used by the `netlink' plugin.
766 <http://www.netfilter.org/projects/libmnl/>
768 * libmodbus (optional)
769 Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
770 `modbus' plugin works with version 2.0.3 of the library – due to frequent
771 API changes other versions may or may not compile cleanly.
772 <http://www.libmodbus.org/>
774 * libmysqlclient (optional)
775 Unsurprisingly used by the `mysql' plugin.
776 <http://dev.mysql.com/>
778 * libnetapp (optional)
779 Required for the `netapp' plugin.
780 This library is part of the “Manage ONTAP SDK” published by NetApp.
782 * libnetsnmp (optional)
783 For the `snmp' plugin.
784 <http://www.net-snmp.org/>
786 * libnotify (optional)
787 For the `notify_desktop' plugin.
788 <http://www.galago-project.org/>
790 * libopenipmi (optional)
791 Used by the `ipmi' plugin to prove IPMI devices.
792 <http://openipmi.sourceforge.net/>
794 * liboping (optional)
795 Used by the `ping' plugin to send and receive ICMP packets.
796 <http://octo.it/liboping/>
798 * libowcapi (optional)
799 Used by the `onewire' plugin to read values from onewire sensors (or the
800 owserver(1) daemon).
801 <http://www.owfs.org/>
803 * libpcap (optional)
804 Used to capture packets by the `dns' plugin.
805 <http://www.tcpdump.org/>
807 * libperfstat (optional)
808 Used by various plugins to gather statistics under AIX.
810 * libperl (optional)
811 Obviously used by the `perl' plugin. The library has to be compiled with
812 ithread support (introduced in Perl 5.6.0).
813 <http://www.perl.org/>
815 * libpq (optional)
816 The PostgreSQL C client library used by the `postgresql' plugin.
817 <http://www.postgresql.org/>
819 * libprotobuf, protoc 3.0+ (optional)
820 Used by the `grpc' plugin to generate service stubs and code to handle
821 network packets of collectd's protobuf-based network protocol.
822 <https://developers.google.com/protocol-buffers/>
824 * libprotobuf-c, protoc-c (optional)
825 Used by the `pinba' plugin to generate a parser for the network packets
826 sent by the Pinba PHP extension.
827 <http://code.google.com/p/protobuf-c/>
829 * libpython (optional)
830 Used by the `python' plugin. Currently, Python 2.6 and later and Python 3
831 are supported.
832 <http://www.python.org/>
834 * librabbitmq (optional; also called “rabbitmq-c”)
835 Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
836 <http://hg.rabbitmq.com/rabbitmq-c/>
838 * librdkafka (optional; also called “rdkafka”)
839 Used by the `write_kafka' plugin for producing messages and sending them
840 to a Kafka broker.
841 <https://github.com/edenhill/librdkafka>
843 * librouteros (optional)
844 Used by the `routeros' plugin to connect to a device running `RouterOS'.
845 <http://octo.it/librouteros/>
847 * librrd (optional)
848 Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
849 client support which was added after version 1.3 of RRDtool. Versions 1.0,
850 1.2 and 1.3 are known to work with the `rrdtool' plugin.
851 <http://oss.oetiker.ch/rrdtool/>
853 * librt, libsocket, libkstat, libdevinfo (optional)
854 Various standard Solaris libraries which provide system functions.
855 <http://developers.sun.com/solaris/>
857 * libsensors (optional)
858 To read from `lm_sensors', see the `sensors' plugin.
859 <http://www.lm-sensors.org/>
861 * libsigrok (optional)
862 Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
863 libzip, and optionally (depending on which drivers are enabled) on
864 libusb, libftdi and libudev.
866 * libstatgrab (optional)
867 Used by various plugins to collect statistics on systems other than Linux
868 and/or Solaris.
869 <http://www.i-scream.org/libstatgrab/>
871 * libtokyotyrant (optional)
872 Used by the `tokyotyrant' plugin.
873 <http://1978th.net/tokyotyrant/>
875 * libupsclient/nut (optional)
876 For the `nut' plugin which queries nut's `upsd'.
877 <http://networkupstools.org/>
879 * libvirt (optional)
880 Collect statistics from virtual machines.
881 <http://libvirt.org/>
883 * libxml2 (optional)
884 Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
885 `virt' plugins.
886 <http://xmlsoft.org/>
888 * libxen (optional)
889 Used by the `xencpu' plugin.
890 <http://xenbits.xensource.com/>
892 * libxmms (optional)
893 <http://www.xmms.org/>
895 * libyajl (optional)
896 Parse JSON data. This is needed for the `ceph', `curl_json' and
897 `log_logstash' plugins.
898 <http://github.com/lloyd/yajl>
900 * libvarnish (optional)
901 Fetches statistics from a Varnish instance. This is needed for the
902 `varnish' plugin.
903 <http://varnish-cache.org>
905 * riemann-c-client (optional)
906 For the `write_riemann' plugin.
907 <https://github.com/algernon/riemann-c-client>
909 Configuring / Compiling / Installing
910 ------------------------------------
912 To configure, build and install collectd with the default settings, run
913 `./configure && make && make install'. For detailed, generic instructions
914 see INSTALL. For a complete list of configure options and their description,
915 run `./configure --help'.
917 By default, the configure script will check for all build dependencies and
918 disable all plugins whose requirements cannot be fulfilled (any other plugin
919 will be enabled). To enable a plugin, install missing dependencies (see
920 section `Prerequisites' above) and rerun `configure'. If you specify the
921 `--enable-<plugin>' configure option, the script will fail if the depen-
922 dencies for the specified plugin are not met. In that case you can force the
923 plugin to be built using the `--enable-<plugin>=force' configure option.
924 This will most likely fail though unless you're working in a very unusual
925 setup and you really know what you're doing. If you specify the
926 `--disable-<plugin>' configure option, the plugin will not be built. If you
927 specify the `--enable-all-plugins' or `--disable-all-plugins' configure
928 options, all plugins will be enabled or disabled respectively by default.
929 Explicitly enabling or disabling a plugin overwrites the default for the
930 specified plugin. These options are meant for package maintainers and should
931 not be used in everyday situations.
933 By default, collectd will be installed into `/opt/collectd'. You can adjust
934 this setting by specifying the `--prefix' configure option - see INSTALL for
935 details. If you pass DESTDIR=<path> to `make install', <path> will be
936 prefixed to all installation directories. This might be useful when creating
937 packages for collectd.
939 Generating the configure script
940 -------------------------------
942 Collectd ships with a `build.sh' script to generate the `configure'
943 script shipped with releases.
945 To generate the `configure` script, you'll need the following dependencies:
947 - autoconf
948 - automake
949 - flex
950 - bison
951 - libtool
952 - libtool-ltdl
953 - pkg-config
955 The `build.sh' script takes no arguments.
957 Crosscompiling
958 --------------
960 To compile correctly collectd needs to be able to initialize static
961 variables to NAN (Not A Number). Some C libraries, especially the GNU
962 libc, have a problem with that.
964 Luckily, with GCC it's possible to work around that problem: One can define
965 NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
966 ``implementation'' the configure script needs to compile and run a short
967 test program. Obviously running a test program when doing a cross-
968 compilation is, well, challenging.
970 If you run into this problem, you can use the `--with-nan-emulation'
971 configure option to force the use of this implementation. We can't promise
972 that the compiled binary actually behaves as it should, but since NANs
973 are likely never passed to the libm you have a good chance to be lucky.
975 Likewise, collectd needs to know the layout of doubles in memory, in order
976 to craft uniform network packets over different architectures. For this, it
977 needs to know how to convert doubles into the memory layout used by x86. The
978 configure script tries to figure this out by compiling and running a few
979 small test programs. This is of course not possible when cross-compiling.
980 You can use the `--with-fp-layout' option to tell the configure script which
981 conversion method to assume. Valid arguments are:
983 * `nothing' (12345678 -> 12345678)
984 * `endianflip' (12345678 -> 87654321)
985 * `intswap' (12345678 -> 56781234)
987 Contact
988 -------
990 For questions, bug reports, development information and basically all other
991 concerns please send an email to collectd's mailing list at
992 <list at collectd.org>.
994 For live discussion and more personal contact visit us in IRC, we're in
995 channel #collectd on freenode.
998 Author
999 ------
1001 Florian octo Forster <octo at collectd.org>,
1002 Sebastian tokkee Harl <sh at tokkee.org>,
1003 and many contributors (see `AUTHORS').
1005 Please use GitHub reporting bugs and submitting pull requests.
1006 See CONTRIBUTING.md for details.