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