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     - uptime
 356       System uptime statistics.
 357
 358     - users
 359       Users currently logged in.
 360
 361     - varnish
 362       Various statistics from Varnish, an HTTP accelerator.
 363
 364     - virt
 365       CPU, memory, disk and network I/O statistics from virtual machines.
 366
 367     - vmem
 368       Virtual memory statistics, e. g. the number of page-ins/-outs or the
 369       number of pagefaults.
 370
 371     - vserver
 372       System resources used by Linux VServers.
 373       See <http://linux-vserver.org/>.
 374
 375     - wireless
 376       Link quality of wireless cards. Linux only.
 377
 378     - xmms
 379       Bitrate and frequency of music played with XMMS.
 380
 381     - zfs_arc
 382       Statistics for ZFS' “Adaptive Replacement Cache” (ARC).
 383
 384     - zookeeper
 385       Read data from Zookeeper's MNTR command.
 386
 387   * Output can be written or sent to various destinations by the following
 388     plugins:
 389
 390     - amqp
 391       Sends JSON-encoded data to an Advanced Message Queuing Protocol (AMQP)
 392       server, such as RabbitMQ.
 393
 394     - csv
 395       Write to comma separated values (CSV) files. This needs lots of
 396       diskspace but is extremely portable and can be analysed with almost
 397       every program that can analyse anything. Even Microsoft's Excel..
 398
 399     - network
 400       Send the data to a remote host to save the data somehow. This is useful
 401       for large setups where the data should be saved by a dedicated machine.
 402
 403     - perl
 404       Of course the values are propagated to plugins written in Perl, too, so
 405       you can easily do weird stuff with the plugins we didn't dare think of
 406       ;) See collectd-perl(5).
 407
 408     - python
 409       It's possible to implement write plugins in Python using the python
 410       plugin. See collectd-python(5) for details.
 411
 412     - rrdcached
 413       Output to round-robin-database (RRD) files using the RRDtool caching
 414       daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general
 415       implementation of the caching done by the `rrdtool' plugin.
 416
 417     - rrdtool
 418       Output to round-robin-database (RRD) files using librrd. See rrdtool(1).
 419       This is likely the most popular destination for such values. Since
 420       updates to RRD-files are somewhat expensive this plugin can cache
 421       updates to the files and write a bunch of updates at once, which lessens
 422       system load a lot.
 423
 424     - unixsock
 425       One can query the values from the unixsock plugin whenever they're
 426       needed. Please read collectd-unixsock(5) for a description on how that's
 427       done.
 428
 429     - write_graphite
 430       Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It
 431       can be configured to avoid logging send errors (especially useful when
 432       using UDP).
 433
 434     - write_http
 435       Sends the values collected by collectd to a web-server using HTTP POST
 436       requests. The transmitted data is either in a form understood by the
 437       Exec plugin or formatted in JSON.
 438
 439     - write_kafka
 440       Sends data to Apache Kafka, a distributed queue.
 441
 442     - write_log
 443       Writes data to the log
 444
 445     - write_mongodb
 446       Sends data to MongoDB, a NoSQL database.
 447
 448     - write_redis
 449       Sends the values to a Redis key-value database server.
 450
 451     - write_riemann
 452       Sends data to Riemann, a stream processing and monitoring system.
 453
 454     - write_sensu
 455       Sends data to Sensu, a stream processing and monitoring system, via the
 456       Sensu client local TCP socket.
 457
 458     - write_tsdb
 459       Sends data OpenTSDB, a scalable no master, no shared state time series
 460       database.
 461
 462   * Logging is, as everything in collectd, provided by plugins. The following
 463     plugins keep up informed about what's going on:
 464
 465     - logfile
 466       Writes log messages to a file or STDOUT/STDERR.
 467
 468     - perl
 469       Log messages are propagated to plugins written in Perl as well.
 470       See collectd-perl(5).
 471
 472     - python
 473       It's possible to implement log plugins in Python using the python plugin.
 474       See collectd-python(5) for details.
 475
 476     - syslog
 477       Logs to the standard UNIX logging mechanism, syslog.
 478
 479     - log_logstash
 480       Writes log messages formatted as logstash JSON events.
 481
 482   * Notifications can be handled by the following plugins:
 483
 484     - notify_desktop
 485       Send a desktop notification to a notification daemon, as defined in
 486       the Desktop Notification Specification. To actually display the
 487       notifications, notification-daemon is required.
 488       See http://www.galago-project.org/specs/notification/.
 489
 490     - notify_email
 491       Send an E-mail with the notification message to the configured
 492       recipients.
 493
 494     - exec
 495       Execute a program or script to handle the notification.
 496       See collectd-exec(5).
 497
 498     - logfile
 499       Writes the notification message to a file or STDOUT/STDERR.
 500
 501     - network
 502       Send the notification to a remote host to handle it somehow.
 503
 504     - perl
 505       Notifications are propagated to plugins written in Perl as well.
 506       See collectd-perl(5).
 507
 508     - python
 509       It's possible to implement notification plugins in Python using the
 510       python plugin. See collectd-python(5) for details.
 511
 512   * Value processing can be controlled using the "filter chain" infrastructure
 513     and "matches" and "targets". The following plugins are available:
 514
 515     - match_empty_counter
 516       Match counter values which are currently zero.
 517
 518     - match_hashed
 519       Match values using a hash function of the hostname.
 520
 521     - match_regex
 522       Match values by their identifier based on regular expressions.
 523
 524     - match_timediff
 525       Match values with an invalid timestamp.
 526
 527     - match_value
 528       Select values by their data sources' values.
 529
 530     - target_notification
 531       Create and dispatch a notification.
 532
 533     - target_replace
 534       Replace parts of an identifier using regular expressions.
 535
 536     - target_scale
 537       Scale (multiply) values by an arbitrary value.
 538
 539     - target_set
 540       Set (overwrite) entire parts of an identifier.
 541
 542   * Miscellaneous plugins:
 543
 544     - aggregation
 545       Selects multiple value lists based on patterns or regular expressions
 546       and creates new aggregated values lists from those.
 547
 548     - threshold
 549       Checks values against configured thresholds and creates notifications if
 550       values are out of bounds. See collectd-threshold(5) for details.
 551
 552     - uuid
 553       Sets the hostname to a unique identifier. This is meant for setups
 554       where each client may migrate to another physical host, possibly going
 555       through one or more name changes in the process.
 556
 557   * Performance: Since collectd is running as a daemon it doesn't spend much
 558     time starting up again and again. With the exception of the exec plugin no
 559     processes are forked. Caching in output plugins, such as the rrdtool and
 560     network plugins, makes sure your resources are used efficiently. Also,
 561     since collectd is programmed multithreaded it benefits from hyper-threading
 562     and multicore processors and makes sure that the daemon isn't idle if only
 563     one plugin waits for an IO-operation to complete.
 564
 565   * Once set up, hardly any maintenance is necessary. Setup is kept as easy
 566     as possible and the default values should be okay for most users.
 567
 568
 569 Operation
 570 ---------
 571
 572   * collectd's configuration file can be found at `sysconfdir'/collectd.conf.
 573     Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)'
 574     for a list of options and a syntax description.
 575
 576   * When the `csv' or `rrdtool' plugins are loaded they'll write the values to
 577     files. The usual place for these files is beneath `/var/lib/collectd'.
 578
 579   * When using some of the plugins, collectd needs to run as user root, since
 580     only root can do certain things, such as craft ICMP packages needed to ping
 581     other hosts. collectd should NOT be installed setuid root since it can be
 582     used to overwrite valuable files!
 583
 584   * Sample scripts to generate graphs reside in `contrib/' in the source
 585     package or somewhere near `/usr/share/doc/collectd' in most distributions.
 586     Please be aware that those script are meant as a starting point for your
 587     own experiments.. Some of them require the `RRDs' Perl module.
 588     (`librrds-perl' on Debian) If you have written a more sophisticated
 589     solution please share it with us.
 590
 591   * The RRAs of the automatically created RRD files depend on the `step'
 592     and `heartbeat' settings given. If change these settings you may need to
 593     re-create the files, losing all data. Please be aware of that when changing
 594     the values and read the rrdtool(1) manpage thoroughly.
 595
 596
 597 collectd and chkrootkit
 598 -----------------------
 599
 600   If you are using the `dns' plugin chkrootkit(1) will report collectd as a
 601   packet sniffer ("<iface>: PACKET SNIFFER(/usr/sbin/collectd[<pid>])"). The
 602   plugin captures all UDP packets on port 53 to analyze the DNS traffic. In
 603   this case, collectd is a legitimate sniffer and the report should be
 604   considered to be a false positive. However, you might want to check that
 605   this really is collectd and not some other, illegitimate sniffer.
 606
 607
 608 Prerequisites
 609 -------------
 610
 611   To compile collectd from source you will need:
 612
 613   * Usual suspects: C compiler, linker, preprocessor, make, ...
 614
 615   * A POSIX-threads (pthread) implementation.
 616     Since gathering some statistics is slow (network connections, slow devices,
 617     etc) collectd is parallelized. The POSIX threads interface is being
 618     used and should be found in various implementations for hopefully all
 619     platforms.
 620
 621   * aerotools-ng (optional)
 622     Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which
 623     is used by the `aerotools-ng' toolkit, is not compiled as a shared object
 624     nor does it feature an installation routine. Therefore, you need to point
 625     collectd's configure script at the source directory of the `aerotools-ng'
 626     project.
 627     <https://github.com/lynix/aerotools-ng>
 628
 629   * CoreFoundation.framework and IOKit.framework (optional)
 630     For compiling on Darwin in general and the `apple_sensors' plugin in
 631     particular.
 632     <http://developer.apple.com/corefoundation/>
 633
 634   * libatasmart (optional)
 635     Used by the `smart' plugin.
 636     <http://git.0pointer.de/?p=libatasmart.git>
 637
 638   * libclntsh (optional)
 639     Used by the `oracle' plugin.
 640
 641   * libhiredis (optional)
 642     Used by the redis plugin. Please note that you require a 0.10.0 version
 643     or higher. <https://github.com/redis/hiredis>
 644
 645   * libcurl (optional)
 646     If you want to use the `apache', `ascent', `bind', `curl', `curl_json',
 647     `curl_xml', `nginx', or `write_http' plugin.
 648     <http://curl.haxx.se/>
 649
 650   * libdbi (optional)
 651     Used by the `dbi' plugin to connect to various databases.
 652     <http://libdbi.sourceforge.net/>
 653
 654   * libesmtp (optional)
 655     For the `notify_email' plugin.
 656     <http://www.stafford.uklinux.net/libesmtp/>
 657
 658   * libganglia (optional)
 659     Used by the `gmond' plugin to process data received from Ganglia.
 660     <http://ganglia.info/>
 661
 662   * libgcrypt (optional)
 663     Used by the `network' plugin for encryption and authentication.
 664     <http://www.gnupg.org/>
 665
 666   * libhal (optional)
 667     If present, the `uuid' plugin will check for UUID from HAL.
 668     <http://hal.freedesktop.org/>
 669
 670   * libi2c-dev (optional)
 671     Used for the plugin `barometer', provides just the i2c-dev.h header file
 672     for user space i2c development.
 673
 674   * libiptc (optional)
 675     For querying iptables counters.
 676     <http://netfilter.org/>
 677
 678   * libjvm (optional)
 679     Library that encapsulates the `Java Virtual Machine' (JVM). This library is
 680     used by the `java' plugin to execute Java bytecode. See “Configuring with
 681     libjvm” below.
 682     <http://openjdk.java.net/> (and others)
 683
 684   * libldap (optional)
 685     Used by the `openldap' plugin.
 686     <http://www.openldap.org/>
 687
 688   * liblvm2 (optional)
 689     Used by the `lvm' plugin.
 690     <ftp://sources.redhat.com/pub/lvm2/>
 691
 692   * libmemcached (optional)
 693     Used by the `memcachec' plugin to connect to a memcache daemon.
 694     <http://tangent.org/552/libmemcached.html>
 695
 696   * libmnl (optional)
 697     Used by the `netlink' plugin.
 698     <http://www.netfilter.org/projects/libmnl/>
 699
 700   * libmodbus (optional)
 701     Used by the `modbus' plugin to communicate with Modbus/TCP devices. The
 702     `modbus' plugin works with version 2.0.3 of the library – due to frequent
 703     API changes other versions may or may not compile cleanly.
 704     <http://www.libmodbus.org/>
 705
 706   * libmysqlclient (optional)
 707     Unsurprisingly used by the `mysql' plugin.
 708     <http://dev.mysql.com/>
 709
 710   * libnetapp (optional)
 711     Required for the `netapp' plugin.
 712     This library is part of the “Manage ONTAP SDK” published by NetApp.
 713
 714   * libnetsnmp (optional)
 715     For the `snmp' plugin.
 716     <http://www.net-snmp.org/>
 717
 718   * libnotify (optional)
 719     For the `notify_desktop' plugin.
 720     <http://www.galago-project.org/>
 721
 722   * libopenipmi (optional)
 723     Used by the `ipmi' plugin to prove IPMI devices.
 724     <http://openipmi.sourceforge.net/>
 725
 726   * liboping (optional)
 727     Used by the `ping' plugin to send and receive ICMP packets.
 728     <http://octo.it/liboping/>
 729
 730   * libowcapi (optional)
 731     Used by the `onewire' plugin to read values from onewire sensors (or the
 732     owserver(1) daemon).
 733     <http://www.owfs.org/>
 734
 735   * libpcap (optional)
 736     Used to capture packets by the `dns' plugin.
 737     <http://www.tcpdump.org/>
 738
 739   * libperfstat (optional)
 740     Used by various plugins to gather statistics under AIX.
 741
 742   * libperl (optional)
 743     Obviously used by the `perl' plugin. The library has to be compiled with
 744     ithread support (introduced in Perl 5.6.0).
 745     <http://www.perl.org/>
 746
 747   * libpq (optional)
 748     The PostgreSQL C client library used by the `postgresql' plugin.
 749     <http://www.postgresql.org/>
 750
 751   * libprotobuf-c, protoc-c (optional)
 752     Used by the `pinba' plugin to generate a parser for the network packets
 753     sent by the Pinba PHP extension, and by the `write_riemann' plugin to
 754     generate events to be sent to a Riemann server.
 755     <http://code.google.com/p/protobuf-c/>
 756
 757   * libpython (optional)
 758     Used by the `python' plugin. Currently, Python 2.3 and later and Python 3
 759     are supported.
 760     <http://www.python.org/>
 761
 762   * librabbitmq (optional; also called “rabbitmq-c”)
 763     Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ.
 764     <http://hg.rabbitmq.com/rabbitmq-c/>
 765
 766   * librdkafka (optional; also called “rdkafka”)
 767     Used by the `write_kafka' plugin for producing messages and sending them
 768     to a Kafka broker.
 769     <https://github.com/edenhill/librdkafka>
 770
 771   * librouteros (optional)
 772     Used by the `routeros' plugin to connect to a device running `RouterOS'.
 773     <http://octo.it/librouteros/>
 774
 775   * librrd (optional)
 776     Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool
 777     client support which was added after version 1.3 of RRDtool. Versions 1.0,
 778     1.2 and 1.3 are known to work with the `rrdtool' plugin.
 779     <http://oss.oetiker.ch/rrdtool/>
 780
 781   * librt, libsocket, libkstat, libdevinfo (optional)
 782     Various standard Solaris libraries which provide system functions.
 783     <http://developers.sun.com/solaris/>
 784
 785   * libsensors (optional)
 786     To read from `lm_sensors', see the `sensors' plugin.
 787     <http://www.lm-sensors.org/>
 788
 789   * libsigrok (optional)
 790     Used by the `sigrok' plugin. In addition, libsigrok depends on glib,
 791     libzip, and optionally (depending on which drivers are enabled) on
 792     libusb, libftdi and libudev.
 793
 794   * libstatgrab (optional)
 795     Used by various plugins to collect statistics on systems other than Linux
 796     and/or Solaris.
 797     <http://www.i-scream.org/libstatgrab/>
 798
 799   * libtokyotyrant (optional)
 800     Used by the `tokyotyrant' plugin.
 801     <http://1978th.net/tokyotyrant/>
 802
 803   * libupsclient/nut (optional)
 804     For the `nut' plugin which queries nut's `upsd'.
 805     <http://networkupstools.org/>
 806
 807   * libvirt (optional)
 808     Collect statistics from virtual machines.
 809     <http://libvirt.org/>
 810
 811   * libxml2 (optional)
 812     Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and
 813     `virt' plugins.
 814     <http://xmlsoft.org/>
 815
 816   * libxmms (optional)
 817     <http://www.xmms.org/>
 818
 819   * libyajl (optional)
 820     Parse JSON data. This is needed for the `ceph', `curl_json' and
 821     `log_logstash' plugins.
 822     <http://github.com/lloyd/yajl>
 823
 824   * libvarnish (optional)
 825      Fetches statistics from a Varnish instance. This is needed for the
 826      `varnish' plugin.
 827      <http://varnish-cache.org>
 828
 829 Configuring / Compiling / Installing
 830 ------------------------------------
 831
 832   To configure, build and install collectd with the default settings, run
 833   `./configure && make && make install'.  For detailed, generic instructions
 834   see INSTALL. For a complete list of configure options and their description,
 835   run `./configure --help'.
 836
 837   By default, the configure script will check for all build dependencies and
 838   disable all plugins whose requirements cannot be fulfilled (any other plugin
 839   will be enabled). To enable a plugin, install missing dependencies (see
 840   section `Prerequisites' above) and rerun `configure'. If you specify the
 841   `--enable-<plugin>' configure option, the script will fail if the depen-
 842   dencies for the specified plugin are not met. In that case you can force the
 843   plugin to be built using the `--enable-<plugin>=force' configure option.
 844   This will most likely fail though unless you're working in a very unusual
 845   setup and you really know what you're doing. If you specify the
 846   `--disable-<plugin>' configure option, the plugin will not be built. If you
 847   specify the `--enable-all-plugins' or `--disable-all-plugins' configure
 848   options, all plugins will be enabled or disabled respectively by default.
 849   Explicitly enabling or disabling a plugin overwrites the default for the
 850   specified plugin. These options are meant for package maintainers and should
 851   not be used in everyday situations.
 852
 853   By default, collectd will be installed into `/opt/collectd'. You can adjust
 854   this setting by specifying the `--prefix' configure option - see INSTALL for
 855   details. If you pass DESTDIR=<path> to `make install', <path> will be
 856   prefixed to all installation directories. This might be useful when creating
 857   packages for collectd.
 858
 859 Configuring with libjvm
 860 -----------------------
 861
 862   To determine the location of the required files of a Java installation is not
 863   an easy task, because the locations vary with your kernel (Linux, SunOS, …)
 864   and with your architecture (x86, SPARC, …) and there is no ‘java-config’
 865   script we could use. Configuration of the JVM library is therefore a bit
 866   tricky.
 867
 868   The easiest way to use the `--with-java=$JAVA_HOME' option, where
 869   `$JAVA_HOME' is usually something like:
 870     /usr/lib/jvm/java-1.5.0-sun-1.5.0.14
 871
 872   The configure script will then use find(1) to look for the following files:
 873
 874     - jni.h
 875     - jni_md.h
 876     - libjvm.so
 877
 878   If found, appropriate CPP-flags and LD-flags are set and the following
 879   library checks succeed.
 880
 881   If this doesn't work for you, you have the possibility to specify CPP-flags,
 882   C-flags and LD-flags for the ‘Java’ plugin by hand, using the following three
 883   (environment) variables:
 884
 885     - JAVA_CPPFLAGS
 886     - JAVA_CFLAGS
 887     - JAVA_LDFLAGS
 888
 889   For example (shortened for demonstration purposes):
 890
 891     ./configure JAVA_CPPFLAGS="-I$JAVA_HOME/include -I$JAVA_HOME/include/linux"
 892
 893   Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to
 894   do that.
 895
 896 Generating the configure script
 897 -------------------------------
 898
 899 Collectd ships with a `build.sh' script to generate the `configure'
 900 script shipped with releases.
 901
 902 To generate the `configure` script, you'll need the following dependencies:
 903
 904 - autoconf
 905 - automake
 906 - flex
 907 - bison
 908 - libtool
 909 - libtool-ltdl
 910
 911 The `build.sh' script takes no arguments.
 912
 913 Crosscompiling
 914 --------------
 915
 916   To compile correctly collectd needs to be able to initialize static
 917   variables to NAN (Not A Number). Some C libraries, especially the GNU
 918   libc, have a problem with that.
 919
 920   Luckily, with GCC it's possible to work around that problem: One can define
 921   NAN as being (0.0 / 0.0) and `isnan' as `f != f'. However, to test this
 922   ``implementation'' the configure script needs to compile and run a short
 923   test program. Obviously running a test program when doing a cross-
 924   compilation is, well, challenging.
 925
 926   If you run into this problem, you can use the `--with-nan-emulation'
 927   configure option to force the use of this implementation. We can't promise
 928   that the compiled binary actually behaves as it should, but since NANs
 929   are likely never passed to the libm you have a good chance to be lucky.
 930
 931   Likewise, collectd needs to know the layout of doubles in memory, in order
 932   to craft uniform network packets over different architectures. For this, it
 933   needs to know how to convert doubles into the memory layout used by x86. The
 934   configure script tries to figure this out by compiling and running a few
 935   small test programs. This is of course not possible when cross-compiling.
 936   You can use the `--with-fp-layout' option to tell the configure script which
 937   conversion method to assume. Valid arguments are:
 938
 939     * `nothing'    (12345678 -> 12345678)
 940     * `endianflip' (12345678 -> 87654321)
 941     * `intswap'    (12345678 -> 56781234)
 942
 943
 944 Contact
 945 -------
 946
 947   For questions, bug reports, development information and basically all other
 948   concerns please send an email to collectd's mailing list at
 949   <list at collectd.org>.
 950
 951   For live discussion and more personal contact visit us in IRC, we're in
 952   channel #collectd on freenode.
 953
 954
 955 Author
 956 ------
 957
 958   Florian octo Forster <octo at collectd.org>,
 959   Sebastian tokkee Harl <sh at tokkee.org>,
 960   and many contributors (see `AUTHORS').
 961
 962   Please send bug reports and patches to the mailing list, see `Contact'
 963   above.
 964