README

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