X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=c3a594091f090ed408bb58fc3a2868ad3bd0c28d;hb=5ff5059ff7e207b61032ed65f7a5288f1b296a9a;hp=2a5502c2e534ee320fcec987d705610a0af7e501;hpb=107a919d0d15d51d774c92ac72879d869e0fa4ee;p=collectd.git diff --git a/README b/README index 2a5502c2..c3a59409 100644 --- a/README +++ b/README @@ -5,8 +5,9 @@ http://collectd.org/ About ----- - collectd is a small daemon which collects statistics about a computer's - usage and writes then into RRD files. + collectd is a small daemon which collects system information periodically + and provides mechanisms to store and monitor the values in a variety of + ways. Features @@ -25,10 +26,26 @@ Features Sensors in Macs running Mac OS X / Darwin: Temperature, fanspeed and voltage sensors. + - ascent + Statistics about Ascent, a free server for the game `World of Warcraft'. + - battery Batterycharge, -current and voltage of ACPI and PMU based laptop batteries. + - curl + Parse statistics from websites using regular expressions. + + - bind + Name server and resolver statistics from the `statistics-channel' + interface of BIND 9.5, 9,6 and later. + + - conntrack + Number of nf_conntrack entries. + + - couchdb + Parse statistics from CouchDB JSON documents. + - cpu CPU utilization: Time spent in the system, user, nice, idle, and related states. @@ -36,6 +53,10 @@ Features - cpufreq CPU frequency (For laptops with speed step or a similar technology) + - dbi + Executes SQL statements on various databases and interprets the returned + data. + - df Mountpoint usage (Basically the values `df(1)' delivers) @@ -58,6 +79,15 @@ Features Values gathered by a custom program or script. See collectd-exec(5). + - filecount + Count the number of files in directories. + + - fscache + Linux file-system based caching framework statistics. + + - gmond + Receive multicast traffic from Ganglia instances. + - hddtemp Harddisk temperatures using hddtempd. @@ -69,6 +99,9 @@ Features Iptables' counters: Number of bytes that were matched by a certain iptables rule. + - ipmi + IPMI (Intelligent Platform Management Interface) sensors information. + - ipvs IPVS connection statistics (number of connections, octets and packets for each service and destination). @@ -77,6 +110,10 @@ Features - irq IRQ counters: Frequency in which certain interrupts occur. + - java + Integrates a `Java Virtual Machine' (JVM) to execute plugins in Java + bytecode. See “Configuring with libjvm” below. + - load System load average over the last 1, 5 and 15 minutes. @@ -87,6 +124,9 @@ Features Motherboard sensors: temperature, fanspeed and voltage information, using mbmon(1). + - memcachec + Query and parse data from a memcache daemon (memcached). + - memcached Statistics of the memcached distributed caching system. @@ -121,13 +161,24 @@ Features Collects statistics from `nginx' (speak: engine X), a HTTP and mail server/proxy. - - ntp + - ntpd NTP daemon statistics: Local clock drift, offset to peers, etc. - nut Network UPS tools: UPS current, voltage, power, charge, utilisation, temperature, etc. See upsd(8). + - onewire (EXPERIMENTAL!) + Read onewire sensors using the owcapu library of the owfs project. + Please read in collectd.conf(5) why this plugin is experimental. + + - openvpn + RX and TX of each client in openvpn-status.log (status-version 2). + + + - oracle + Query data from an Oracle database. + - perl The perl plugin implements a Perl-interpreter into collectd. You can write your own plugins in Perl and return arbitrary values using this @@ -137,9 +188,22 @@ Features Network latency: Time to reach the default gateway or another given host. + - postgresql + PostgreSQL database statistics: active server connections, transaction + numbers, block IO, table row manipulations. + + - powerdns + PowerDNS name server statistics. + - processes Process counts: Number of running, sleeping, zombie, ... processes. + - protocols + Counts various aspects of network protocols such as IP, TCP, UDP, etc. + + - rrdcached + RRDtool caching daemon (RRDcacheD) statistics. + - sensors System sensors, accessed using lm_sensors: Voltages, temperatures and fan rotation speeds. @@ -155,15 +219,38 @@ Features - swap Pages swapped out onto harddisk 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 + values. + - tape Bytes and operations read and written on tape devices. Solaris only. - tcpconns Number of TCP connections to specific local and remote ports. + - teamspeak2 + TeamSpeak2 server statistics. + + - ted + Plugin to read values from `The Energy Detective' (TED). + + - thermal + Linux ACPI thermal zone information. + + - uptime + System uptime statistics. + - users Users currently logged in. + - vmem + Virtual memory statistics, e. g. the number of page-ins/-outs or the + number of pagefaults. + - vserver System resources used by Linux VServers. See . @@ -191,6 +278,11 @@ Features you can easily do weird stuff with the plugins we didn't dare think of ;) See collectd-perl(5). + - rrdcached + Output to round-robin-database (RRD) files using the RRDtool caching + daemon (RRDcacheD) - see rrdcached(1). That daemon provides a general + implementation of the caching done by the `rrdtool' plugin. + - rrdtool Output to round-robin-database (RRD) files using librrd. See rrdtool(1). This is likely the most popular destination for such values. Since @@ -209,9 +301,67 @@ Features - logfile Writes logmessages to a file or STDOUT/STDERR. + - perl + Log messages are propagated to plugins written in Perl as well. + See collectd-perl(5). + - syslog Logs to the standard UNIX logging mechanism, syslog. + * Notifications can be handled by the following plugins: + + - notify_desktop + Send a desktop notification to a notification daemon, as defined in + the Desktop Notification Specification. To actually display the + notifications, notification-daemon is required. + See http://www.galago-project.org/specs/notification/. + + - notify_email + Send an E-mail with the notification message to the configured + recipients. + + - exec + Execute a program or script to handle the notification. + See collectd-exec(5). + + - logfile + Writes the notification message to a file or STDOUT/STDERR. + + - network + Send the notification to a remote host to handle it somehow. + + - perl + Notifications are propagated to plugins written in Perl as well. + See collectd-perl(5). + + * Value processing can be controlled using the "filter chain" infrastructure + and "matches" and "targets". The following plugins are available: + + - match_regex + Match values by their identifier based on regular expressions. + + - match_timediff + Match values with an invalid timestamp. + + - match_value + Select values by their data sources' values. + + - target_notification + Create and dispatch a notification. + + - target_replace + Replace parts of an identifier using regular expressions. + + - target_set + Set (overwrite) entire parts of an identifier. + + * Miscellaneous plugins: + + - uuid + Sets the hostname to an 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. + * Performance: Since collectd is running as a daemon it doesn't spend much 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 @@ -219,7 +369,7 @@ Features since collectd is programmed multithreaded it benefits from hyperthreading and multicore processors and makes sure that the daemon isn't idle if only one plugins waits for an IO-operation to complete. - + * Once set up, hardly any maintenance is necessary. Setup is kept as easy as possible and the default values should be okay for most users. @@ -276,61 +426,125 @@ Prerequisites used and should be found in various implementations for hopefully all platforms. + * CoreFoundation.framework and IOKit.framework (optional) + For compiling on Darwin in general and the `apple_sensors' plugin in + particular. + + + * libclntsh (optional) + Used by the `oracle' plugin. + * libcurl (optional) - If you want to use the `apache' and/or `nginx' plugins. + If you want to use the `apache', `ascent', `curl' or `nginx' plugin. + + + * libdbi (optional) + Used by the `dbi' plugin to connect to various databases. + + + * libesmtp (optional) + For the `notify_email' plugin. + + + * libganglia (optional) + Used by the `gmond' plugin to process data received from Ganglia. - * libiptc (optional) + * libgcrypt (optional) + Used by the `network' plugin for encryption and authentication. + + * libhal (optional) + If present, the uuid plugin will check for UUID from HAL. + + + * libiptc (optional, if not found a version shipped with this distribution + can be used if the Linux kernel headers are available) For querying iptables counters. + + + * 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 + libjvm” below. + + * libmemcached (optional) + Used by the `memcachec' plugin to connect to a memcache daemon. * libmysqlclient (optional) Unsurprisingly used by the `mysql' plugin. + * libnetlink (optional) Used, obviously, for the `netlink' plugin. + * libnetsnmp (optional) For the `snmp' plugin. + + + * libnotify (optional) + For the `notify_desktop' plugin. + * liboping (optional, if not found a version shipped with this distribution can be used) 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 + owserver(1) daemon). + * libpcap (optional) Used to capture packets by the `dns' plugin. + * libperl (optional) Obviously used by the `perl' plugin. The library has to be compiled with ithread support (introduced in Perl 5.6.0). + - * librrd (optional; headers and library; rrdtool 1.0 and 1.2 both work fine) - If built without `librrd' the resulting binary will be `client only', i.e. - will send its values via multicast and not create any RRD files itself. - Alternatively you can chose to write CSV-files (Comma Separated Values) - instead. + * libpq (optional) + The PostgreSQL C client library used by the `postgresql' plugin. + + + * librrd (optional) + Used by the `rrdtool' and `rrdcached' plugins. The latter requires RRDtool + client support which was added after version 1.3 of RRDtool. Versions 1.0, + 1.2 and 1.3 are known to work with the `rrdtool' plugin. + + + * librt, libsocket, libkstat, libdevinfo (optional) + Various standard Solaris libraries which provide system functions. + * libsensors (optional) To read from `lm_sensors', see the `sensors' plugin. + - * libstatgrab may be used to collect statistics on systems other than Linux - and/or Solaris. Note that CPU- and disk-statistics, while being provided - by this library, are not supported in collectd right now.. - + * libstatgrab (optional) + Used by various plugins to collect statistics on systems other than Linux + and/or Solaris. + * libupsclient/nut (optional) For the `nut' plugin which queries nut's `upsd'. - - * libxmms (optional) - - * librt, libsocket, libkstat, libdevinfo - Various standard Solaris libraries which provide system functions. - - * CoreFoundation.framework and IOKit.framework - For compiling on Darwin in general and the `apple_sensors' plugin in - particular. + * libvirt (optional) Collect statistics from virtual machines. + + * libxml2 (optional) + Parse XML data. This is needed for the `ascent' and `libvirt' plugins. + + + * libxmms (optional) + + + * libyajl (optional) + Parse JSON data. This is needed for the `couchdb' plugin. + Configuring / Compiling / Installing ------------------------------------ @@ -339,14 +553,22 @@ Configuring / Compiling / Installing `./configure && make && make install'. For detailed, generic instructions see INSTALL. For a complete list of configure options and their description, run `./configure --help'. - + By default, the configure script will check for all build dependencies and disable all plugins whose requirements cannot be fulfilled (any other plugin will be enabled). To enable a plugin, install missing dependencies (see section `Prerequisites' above) and rerun `configure'. If you specify the - `--enable-' configure option, you can force the plugin to be built. + `--enable-' configure option, the script will fail if the depen- + dencies for the specified plugin are not met. In that case you can force the + plugin to be built using the `--enable-=force' configure option. This will most likely fail though unless you're working in a very unusual - setup and you really know what you're doing. + setup and you really know what you're doing. If you specify the + `--disable-' configure option, the plugin will not be built. If you + specify the `--enable-all-plugins' or `--disable-all-plugins' configure + options, all plugins will be enabled or disabled respectively by default. + Explicitly enabling or disabling a plugin overwrites the default for the + specified plugin. These options are meant for package maintainers and should + not be used in everyday situations. By default, collectd will be installed into `/opt/collectd'. You can adjust this setting by specifying the `--prefix' configure option - see INSTALL for @@ -354,6 +576,42 @@ Configuring / Compiling / Installing prefixed to all installation directories. This might be useful when creating packages for collectd. +Configuring with libjvm +----------------------- + + To determine the location of the required files of a Java installation is not + an easy task, because the locations vary with your kernel (Linux, SunOS, …) + and with your architecture (x86, SPARC, …) and there is no ‘java-config’ + script we could use. Configuration of the JVM library is therefore a bit + tricky. + + The easiest way to use the `--with-java=$JAVA_HOME' option, where + `$JAVA_HOME' is usually something like: + /usr/lib/jvm/java-1.5.0-sun-1.5.0.14 + + The configure script will then use find(1) to look for the following files: + + - jni.h + - jni_md.h + - libjvm.so + + If found, appropriate CPP-flags and LD-flags are set and the following + library checks succeed. + + If this doesn't work for you, you have the possibility to specify CPP-flags, + C-flags and LD-flags for the ‘Java’ plugin by hand, using the following three + (environment) variables: + + - JAVA_CPPFLAGS + - JAVA_CFLAGS + - JAVA_LDFLAGS + + For example (shortened for demonstration purposes): + + ./configure JAVA_CPPFLAGS="-I$JAVA_HOME/include -I$JAVA_HOME/include/linux" + + Adding "-ljvm" to the JAVA_LDFLAGS is done automatically, you don't have to + do that. Crosscompiling -------------- @@ -373,12 +631,24 @@ Crosscompiling that the compiled binary actually behaves as it should, but since NANs are likely never passed to the libm you have a good chance to be lucky. + Likewise, collectd needs to know the layout of doubles in memory, in order + to craft uniform network packets over different architectures. For this, it + needs to know how to convert doubles into the memory layout used by x86. The + configure script tries to figure this out by compiling and running a few + small test programs. This is of course not possible when cross-compiling. + You can use the `--with-fp-layout' option to tell the configure script which + conversion method to assume. Valid arguments are: + + * `nothing' (12345678 -> 12345678) + * `endianflip' (12345678 -> 87654321) + * `intswap' (12345678 -> 56781234) + Contact ------- - For questions, bugreports, development information and basically all other - concerns please send an email to collectd's mailinglist at + 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 @@ -392,5 +662,6 @@ Author Sebastian tokkee Harl , and many contributors (see `AUTHORS'). - Please send bugreports and patches to the mailinglist, see `Contact' above. + Please send bug reports and patches to the mailing list, see `Contact' + above.