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