X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=1956609b2d705041423947f3b4ad000fac02dd0d;hb=7cea19815ba24735e91dde1c08a889960b299b62;hp=1c23aaab642cd03517165fe83d4eec27ad4999a5;hpb=4922870de509750a6c74d06371c5ddeed5bdec89;p=collectd.git diff --git a/README b/README index 1c23aaab..1956609b 100644 --- a/README +++ b/README @@ -16,19 +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 water cooling board made by Aquacomputer. + - ascent Statistics about Ascent, a free server for the game `World of Warcraft'. + - barometer + Using digital barometer sensor MPL115A2 or MPL3115 from Freescale + provides absolute barometric pressure, air pressure reduced to sea level + and temperature. + - battery Batterycharge, -current and voltage of ACPI and PMU based laptop batteries. @@ -37,6 +45,9 @@ Features Name server and resolver statistics from the `statistics-channel' interface of BIND 9.5, 9,6 and later. + - cgroups + CPU accounting information for process groups under Linux. + - conntrack Number of nf_conntrack entries. @@ -74,7 +85,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. @@ -100,7 +114,7 @@ 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 @@ -144,7 +158,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 @@ -162,6 +176,10 @@ Features Memory utilization: Memory occupied by running processes, page cache, buffer cache and free. + - mic + Collects CPU usage, memory usage, temperatures and power consumption from + Intel Many Integrated Core (MIC) CPUs. + - modbus Reads values from Modbus/TCP enabled devices. Supports reading values from multiple "slaves" so gateway devices can be used. @@ -257,7 +275,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 @@ -273,19 +291,28 @@ Features - serial RX and TX of serial interfaces. Linux only; needs root privileges. + - sigrok + Uses libsigrok as a backend, allowing any sigrok-supported device + to have its measurements fed to collectd. This includes multimeters, + sound level meters, thermometers, and much more. + - 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 @@ -380,13 +407,22 @@ Features done. - write_graphite - Sends data to Carbon, the storage layer of Graphite. + Sends data to Carbon, the storage layer of Graphite using TCP or UDP. It + can be configured to avoid logging send errors (especially useful when + using UDP). + + - write_tsdb + Sends data OpenTSDB, a scalable no master, no shared state time series + database. - write_http Sends the values collected by collectd to a web-server using HTTP POST 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_mongodb Sends data to MongoDB, a NoSQL database. @@ -400,7 +436,7 @@ Features plugins keep up 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. @@ -413,6 +449,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 @@ -484,7 +523,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. @@ -492,7 +531,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. @@ -504,7 +543,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 @@ -548,10 +587,18 @@ 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. + * aerotools-ng (optional) + Used by the `aquaero' plugin. Currently, the `libaquaero5' library, which + is used by the `aerotools-ng' toolkit, is not compiled as a shared object + nor does it feature an installation routine. Therefore, you need to point + collectd's configure script at the source directory of the `aerotools-ng' + project. + + * CoreFoundation.framework and IOKit.framework (optional) For compiling on Darwin in general and the `apple_sensors' plugin in particular. @@ -561,12 +608,12 @@ Prerequisites Used by the `oracle' plugin. * libcredis (optional) - Used by the redis plugin. Please note that you require a 0.2.2 version + Used by the `redis' plugin. Please note that you require a 0.2.2 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) @@ -586,32 +633,38 @@ 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) + * liblvm2 (optional) + Used by the `lvm' plugin. + + * libmemcached (optional) Used by the `memcachec' plugin to connect to a memcache daemon. + * libmnl (optional) + Used by the `netlink' plugin. + + * 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. @@ -620,13 +673,9 @@ 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. - * libnetlink (optional) - Used, obviously, for the `netlink' plugin. - - * libnetsnmp (optional) For the `snmp' plugin. @@ -635,9 +684,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 @@ -662,7 +715,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) @@ -671,12 +725,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 @@ -692,13 +751,18 @@ Prerequisites To read from `lm_sensors', see the `sensors' plugin. + * libsigrok (optional) + 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. + * libstatgrab (optional) Used by various plugins to collect statistics on systems other than Linux and/or Solaris. * libtokyotyrant (optional) - Used by the tokyotyrant plugin. + Used by the `tokyotyrant' plugin. * libupsclient/nut (optional) @@ -710,18 +774,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 + `libvirt' plugins. * libxmms (optional) * libyajl (optional) - Parse JSON data. This is needed for the `curl_json' plugin. + Parse JSON data. This is needed for the `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 @@ -827,7 +894,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. @@ -836,7 +903,7 @@ Contact Author ------ - Florian octo Forster , + Florian octo Forster , Sebastian tokkee Harl , and many contributors (see `AUTHORS').