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