X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=README;h=3e2c0233adc3ea9ccfbcbbf072c107a0f6dcbd5b;hp=430f52cdbb1f5e6b17399e2744a56cf249401844;hb=3812f29af0b4ae25d1e0114ee0afc4a83880e913;hpb=84f5f5923d8109366b2c3caf66ad7c2d89be38bd diff --git a/README b/README index 430f52cd..3e2c0233 100644 --- a/README +++ b/README @@ -16,22 +16,27 @@ Features * collectd is able to collect the following data: - apache - Apache server utilization: Number of bytes transfered, number of + Apache server utilization: Number of bytes transferred, number of requests handled and detailed scoreboard statistics - apcups APC UPS Daemon: UPS charge, load, input/output/battery voltage, etc. - apple_sensors - Sensors in Macs running Mac OS X / Darwin: Temperature, fanspeed and + Sensors in Macs running Mac OS X / Darwin: Temperature, fan speed and voltage sensors. - aquaero - Various sensors in the Aquaero 5 watercooling board made by Aquacomputer. + Various sensors in the Aquaero 5 water cooling board made by Aquacomputer. - ascent Statistics about Ascent, a free server for the game `World of Warcraft'. + - barometer + Reads absolute barometric pressure, air pressure reduced to sea level and + temperature. Supported sensors are MPL115A2 and MPL3115 from Freescale + and BMP085 from Bosch. + - battery Batterycharge, -current and voltage of ACPI and PMU based laptop batteries. @@ -40,6 +45,9 @@ Features Name server and resolver statistics from the `statistics-channel' interface of BIND 9.5, 9,6 and later. + - ceph + Statistics from the Ceph distributed storage system. + - cgroups CPU accounting information for process groups under Linux. @@ -80,7 +88,10 @@ Features - dns DNS traffic: Query types, response codes, opcodes and traffic/octets - transfered. + transferred. + + - drbd + Collect individual drbd resource statistics. - email Email statistics: Count, traffic, spam scores and checks. @@ -96,6 +107,9 @@ Features Values gathered by a custom program or script. See collectd-exec(5). + - fhcount + File handles statistics. + - filecount Count the number of files in directories. @@ -106,19 +120,23 @@ Features Receive multicast traffic from Ganglia instances. - hddtemp - Harddisk temperatures using hddtempd. + Hard disk temperatures using hddtempd. - interface Interface traffic: Number of octets, packets and errors for each interface. - - iptables - Iptables' counters: Number of bytes that were matched by a certain - iptables rule. + - ipc + IPC counters: semaphores used, number of allocated segments in shared + memory and more. - ipmi IPMI (Intelligent Platform Management Interface) sensors information. + - iptables + Iptables' counters: Number of bytes that were matched by a certain + iptables rule. + - ipvs IPVS connection statistics (number of connections, octets and packets for each service and destination). @@ -138,9 +156,6 @@ Features Detailed CPU statistics of the “Logical Partitions” virtualization technique built into IBM's POWER processors. - - libvirt - CPU, memory, disk and network I/O statistics from virtual machines. - - lvm Size of “Logical Volumes” (LV) and “Volume Groups” (VG) of Linux' “Logical Volume Manager” (LVM). @@ -150,7 +165,7 @@ Features interfaces that use the Atheros chipset and the MadWifi driver. - mbmon - Motherboard sensors: temperature, fanspeed and voltage information, + Motherboard sensors: temperature, fan speed and voltage information, using mbmon(1). - md @@ -209,13 +224,13 @@ Features - ntpd NTP daemon statistics: Local clock drift, offset to peers, etc. + - numa + Information about Non-Uniform Memory Access (NUMA). + - nut Network UPS tools: UPS current, voltage, power, charge, utilisation, temperature, etc. See upsd(8). - - numa - Information about Non-Uniform Memory Access (NUMA). - - olsrd Queries routing information from the “Optimized Link State Routing” daemon. @@ -224,6 +239,9 @@ Features Read onewire sensors using the owcapu library of the owfs project. Please read in collectd.conf(5) why this plugin is experimental. + - openldap + Read monitoring information from OpenLDAP's cn=Monitor subtree. + - openvpn RX and TX of each client in openvpn-status.log (status-version 2). @@ -267,7 +285,7 @@ Features See collectd-python(5) for details. - redis - The redis plugin gathers information from a redis server, including: + The redis plugin gathers information from a Redis server, including: uptime, used memory, total connections etc. - routeros @@ -288,19 +306,27 @@ Features to have its measurements fed to collectd. This includes multimeters, sound level meters, thermometers, and much more. + - smart + Collect SMART statistics, notably load cycle count, temperature + and bad sectors. + - snmp Read values from SNMP (Simple Network Management Protocol) enabled network devices such as switches, routers, thermometers, rack monitoring servers, etc. See collectd-snmp(5). + - statsd + Acts as a StatsD server, reading values sent over the network from StatsD + clients and calculating rates and other aggregates out of these values. + - swap - Pages swapped out onto harddisk or whatever is called `swap' by the OS.. + Pages swapped out onto hard disk or whatever is called `swap' by the OS.. - table Parse table-like structured files. - tail - Follows (tails) logfiles, parses them by lines and submits matched + Follows (tails) log files, parses them by lines and submits matched values. - tail_csv @@ -326,6 +352,10 @@ Features Reads the number of records and file size from a running Tokyo Tyrant server. + - turbostat + Reads CPU frequency and C-state residency on modern Intel + turbo-capable processors. + - uptime System uptime statistics. @@ -335,6 +365,9 @@ Features - varnish Various statistics from Varnish, an HTTP accelerator. + - virt + CPU, memory, disk and network I/O statistics from virtual machines. + - vmem Virtual memory statistics, e. g. the number of page-ins/-outs or the number of pagefaults. @@ -352,6 +385,9 @@ Features - zfs_arc Statistics for ZFS' “Adaptive Replacement Cache” (ARC). + - zookeeper + Read data from Zookeeper's MNTR command. + * Output can be written or sent to various destinations by the following plugins: @@ -404,6 +440,12 @@ Features requests. The transmitted data is either in a form understood by the Exec plugin or formatted in JSON. + - write_kafka + Sends data to Apache Kafka, a distributed queue. + + - write_log + Writes data to the log + - write_mongodb Sends data to MongoDB, a NoSQL database. @@ -413,11 +455,19 @@ Features - write_riemann Sends data to Riemann, a stream processing and monitoring system. + - write_sensu + Sends data to Sensu, a stream processing and monitoring system, via the + Sensu client local TCP socket. + + - write_tsdb + Sends data OpenTSDB, a scalable no master, no shared state time series + database. + * Logging is, as everything in collectd, provided by plugins. The following plugins keep us informed about what's going on: - logfile - Writes logmessages to a file or STDOUT/STDERR. + Writes log messages to a file or STDOUT/STDERR. - perl Log messages are propagated to plugins written in Perl as well. @@ -430,6 +480,9 @@ Features - syslog Logs to the standard UNIX logging mechanism, syslog. + - log_logstash + Writes log messages formatted as logstash JSON events. + * Notifications can be handled by the following plugins: - notify_desktop @@ -501,7 +554,7 @@ Features values are out of bounds. See collectd-threshold(5) for details. - uuid - Sets the hostname to an unique identifier. This is meant for setups + Sets the hostname to a unique identifier. This is meant for setups where each client may migrate to another physical host, possibly going through one or more name changes in the process. @@ -509,7 +562,7 @@ Features time starting up again and again. With the exception of the exec plugin no processes are forked. Caching in output plugins, such as the rrdtool and network plugins, makes sure your resources are used efficiently. Also, - since collectd is programmed multithreaded it benefits from hyperthreading + since collectd is programmed multithreaded it benefits from hyper-threading and multicore processors and makes sure that the daemon isn't idle if only one plugin waits for an IO-operation to complete. @@ -521,7 +574,7 @@ Operation --------- * collectd's configuration file can be found at `sysconfdir'/collectd.conf. - Run `collectd -h' for a list of builtin defaults. See `collectd.conf(5)' + Run `collectd -h' for a list of built-in defaults. See `collectd.conf(5)' for a list of options and a syntax description. * When the `csv' or `rrdtool' plugins are loaded they'll write the values to @@ -565,7 +618,7 @@ Prerequisites * A POSIX-threads (pthread) implementation. Since gathering some statistics is slow (network connections, slow devices, - etc) the collectd is parallelized. The POSIX threads interface is being + etc) collectd is parallelized. The POSIX threads interface is being used and should be found in various implementations for hopefully all platforms. @@ -582,16 +635,26 @@ Prerequisites particular. + * libatasmart (optional) + Used by the `smart' plugin. + + + * libcap (optional) + The `turbostat' plugin can optionally build Linux Capabilities support, + which avoids full privileges requirement (aka. running as root) to read + values. + + * libclntsh (optional) Used by the `oracle' plugin. - * libcredis (optional) - Used by the redis plugin. Please note that you require a 0.2.2 version - or higher. + * libhiredis (optional) + Used by the redis plugin. Please note that you require a 0.10.0 version + or higher. * libcurl (optional) - If you want to use the `apache', `ascent', `curl', `nginx', or `write_http' - plugin. + If you want to use the `apache', `ascent', `bind', `curl', `curl_json', + `curl_xml', `nginx', or `write_http' plugin. * libdbi (optional) @@ -611,25 +674,31 @@ Prerequisites * libhal (optional) - If present, the uuid plugin will check for UUID from HAL. + If present, the `uuid' plugin will check for UUID from HAL. + * libi2c-dev (optional) + Used for the plugin `barometer', provides just the i2c-dev.h header file + for user space i2c development. + * libiptc (optional) For querying iptables counters. - If not found on the system, a version shipped with this distribution can - be used. It requires some Linux headers in /usr/include/linux. You can - force the build system to use the shipped version by specifying - --with-libiptc=shipped - when running the configure script. - * libjvm (optional) Library that encapsulates the `Java Virtual Machine' (JVM). This library is - used by the Java plugin to execute Java bytecode. See “Configuring with + used by the `java' plugin to execute Java bytecode. See “Configuring with libjvm” below. (and others) + * libldap (optional) + Used by the `openldap' plugin. + + + * liblvm2 (optional) + Used by the `lvm' plugin. + + * libmemcached (optional) Used by the `memcachec' plugin to connect to a memcache daemon. @@ -639,8 +708,8 @@ Prerequisites * libmodbus (optional) - Used by the “modbus” plugin to communicate with Modbus/TCP devices. The - “modbus” plugin works with version 2.0.3 of the library – due to frequent + Used by the `modbus' plugin to communicate with Modbus/TCP devices. The + `modbus' plugin works with version 2.0.3 of the library – due to frequent API changes other versions may or may not compile cleanly. @@ -649,7 +718,7 @@ Prerequisites * libnetapp (optional) - Required for the “netapp” plugin. + Required for the `netapp' plugin. This library is part of the “Manage ONTAP SDK” published by NetApp. * libnetsnmp (optional) @@ -660,9 +729,13 @@ Prerequisites For the `notify_desktop' plugin. + * libopenipmi (optional) + Used by the `ipmi' plugin to prove IPMI devices. + + * liboping (optional) Used by the `ping' plugin to send and receive ICMP packets. - + * libowcapi (optional) Used by the `onewire' plugin to read values from onewire sensors (or the @@ -687,7 +760,8 @@ Prerequisites * libprotobuf-c, protoc-c (optional) Used by the `pinba' plugin to generate a parser for the network packets - sent by the Pinba PHP extension. + sent by the Pinba PHP extension, and by the `write_riemann' plugin to + generate events to be sent to a Riemann server. * libpython (optional) @@ -696,12 +770,17 @@ Prerequisites * librabbitmq (optional; also called “rabbitmq-c”) - Used by the AMQP plugin for AMQP connections, for example to RabbitMQ. + Used by the `amqp' plugin for AMQP connections, for example to RabbitMQ. + * librdkafka (optional; also called “rdkafka”) + Used by the `write_kafka' plugin for producing messages and sending them + to a Kafka broker. + + * librouteros (optional) Used by the `routeros' plugin to connect to a device running `RouterOS'. - + * librrd (optional) Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool @@ -718,7 +797,7 @@ Prerequisites * libsigrok (optional) - Used by the sigrok plugin. In addition, libsigrok depends on glib, + Used by the `sigrok' plugin. In addition, libsigrok depends on glib, libzip, and optionally (depending on which drivers are enabled) on libusb, libftdi and libudev. @@ -728,7 +807,7 @@ Prerequisites * libtokyotyrant (optional) - Used by the tokyotyrant plugin. + Used by the `tokyotyrant' plugin. * libupsclient/nut (optional) @@ -740,18 +819,21 @@ Prerequisites * libxml2 (optional) - Parse XML data. This is needed for the `ascent' and `libvirt' plugins. + Parse XML data. This is needed for the `ascent', `bind', `curl_xml' and + `virt' plugins. * libxmms (optional) * libyajl (optional) - Parse JSON data. This is needed for the `curl_json' plugin. + Parse JSON data. This is needed for the `ceph', `curl_json' and + `log_logstash' plugins. * libvarnish (optional) - Fetches statistics from a Varnish instance. This is needed for the Varnish plugin + Fetches statistics from a Varnish instance. This is needed for the + `varnish' plugin. Configuring / Compiling / Installing @@ -821,6 +903,23 @@ Configuring with libjvm Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to do that. +Generating the configure script +------------------------------- + +Collectd ships with a `build.sh' script to generate the `configure' +script shipped with releases. + +To generate the `configure` script, you'll need the following dependencies: + +- autoconf +- automake +- flex +- bison +- libtool +- libtool-ltdl + +The `build.sh' script takes no arguments. + Crosscompiling -------------- @@ -857,7 +956,7 @@ Contact For questions, bug reports, development information and basically all other concerns please send an email to collectd's mailing list at - . + . For live discussion and more personal contact visit us in IRC, we're in channel #collectd on freenode. @@ -866,7 +965,7 @@ Contact Author ------ - Florian octo Forster , + Florian octo Forster , Sebastian tokkee Harl , and many contributors (see `AUTHORS').