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