X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=83eede283e2a16a14c50486f88dcf1f3c055eede;hb=5137825deeb5d4a5b763185f45b3916ccc49340d;hp=8c8160ce92a200217571a7b49ae54095ba0ef6f5;hpb=be6ba7cafbff66111260b34254d317a740c4c978;p=collectd.git diff --git a/README b/README index 8c8160ce..83eede28 100644 --- a/README +++ b/README @@ -33,6 +33,19 @@ Features 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. @@ -69,6 +82,12 @@ Features - 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. @@ -91,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. @@ -101,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. @@ -146,6 +172,13 @@ Features 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 @@ -165,6 +198,9 @@ Features - 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. @@ -183,6 +219,9 @@ 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. @@ -196,9 +235,18 @@ Features - teamspeak2 TeamSpeak2 server statistics. + - ted + Plugin to read values from `The Energy Detective' (TED). + - thermal Linux ACPI thermal zone information. + - tokyotyrant + Record in and file size of a Tokyo Cabinet database file. + + - uptime + System uptime statistics. + - users Users currently logged in. @@ -289,6 +337,27 @@ Features 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 @@ -365,8 +434,11 @@ Prerequisites particular. + * libclntsh (optional) + Used by the `oracle' plugin. + * libcurl (optional) - If you want to use the `apache', `ascent', or `nginx' plugin. + If you want to use the `apache', `ascent', `curl' or `nginx' plugin. * libdbi (optional) @@ -377,6 +449,12 @@ Prerequisites For the `notify_email' plugin. + * libganglia (optional) + Used by the `gmond' plugin to process data received from Ganglia. + + * libgcrypt (optional) + Used by the `network' plugin for encryption and authentication. + * libhal (optional) If present, the uuid plugin will check for UUID from HAL. @@ -386,6 +464,14 @@ Prerequisites 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. @@ -459,6 +545,9 @@ Prerequisites * libxmms (optional) + * libyajl (optional) + Parse JSON data. This is needed for the `couchdb' plugin. + Configuring / Compiling / Installing ------------------------------------ @@ -472,9 +561,17 @@ Configuring / Compiling / Installing 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 @@ -482,6 +579,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 -------------- @@ -501,12 +634,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 @@ -520,5 +665,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.