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