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