X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=2a1aa69add9613417106dce5a1072f59eb1e539f;hb=d99dc6b0dc0f4f096ebb93c827a0cea2fd4e09e2;hp=97b66f7902a7d0d130623440b2e6b3f9950f3264;hpb=452db816211a3a5322caaedc28fa17ffff72161d;p=collectd.git diff --git a/README b/README index 97b66f79..2a1aa69a 100644 --- a/README +++ b/README @@ -33,6 +33,10 @@ Features Batterycharge, -current and voltage of ACPI and PMU based laptop batteries. + - bind + Name server and resolver statistics from the `statistics-channel' + interface of BIND 9.5, 9,6 and later. + - cpu CPU utilization: Time spent in the system, user, nice, idle, and related states. @@ -40,6 +44,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) @@ -62,6 +70,9 @@ Features Values gathered by a custom program or script. See collectd-exec(5). + - filecount + Count the number of files in directories. + - hddtemp Harddisk temperatures using hddtempd. @@ -73,6 +84,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). @@ -132,6 +146,14 @@ Features 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). + + - perl The perl plugin implements a Perl-interpreter into collectd. You can write your own plugins in Perl and return arbitrary values using this @@ -141,9 +163,19 @@ 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. + - rrdcached + RRDtool caching daemon (RRDcacheD) statistics. + - sensors System sensors, accessed using lm_sensors: Voltages, temperatures and fan rotation speeds. @@ -169,6 +201,12 @@ Features - tcpconns Number of TCP connections to specific local and remote ports. + - teamspeak2 + TeamSpeak2 server statistics. + + - thermal + Linux ACPI thermal zone information. + - users Users currently logged in. @@ -203,6 +241,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 @@ -215,6 +258,13 @@ Features needed. Please read collectd-unixsock(5) for a description on how that's done. + * Filtering and rewriting values dispatched to collectd can be done by the + following plugins: + + - filter_pcre + Filter and rewrite value lists based on Perl-compatible regular + expressions. + * Logging is, as everything in collectd, provided by plugins. The following plugins keep up informed about what's going on: @@ -230,6 +280,16 @@ Features * 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). @@ -258,7 +318,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. @@ -315,66 +375,108 @@ 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. + + * libcurl (optional) If you want to use the `apache', `ascent', or `nginx' plugin. + + + * libdbi (optional) + Used by the `dbi' plugin to connect to various databases. + + + * libesmtp (optional) + For the `notify_email' plugin. + * libhal (optional) If present, the uuid plugin will check for UUID from HAL. + - * libiptc (optional) + * 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. + * 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. + + + * libpcre (optional) + Used by the `filter_pcre' plugin. + * libperl (optional) Obviously used by the `perl' plugin. The library has to be compiled with ithread support (introduced in Perl 5.6.0). + + + * libpq (optional) + The PostgreSQL C client library used by the `postgresql' plugin. + - * 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. + * 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) + Configuring / Compiling / Installing @@ -384,7 +486,7 @@ 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