From: Florian Forster Date: Sat, 19 May 2007 13:42:55 +0000 (+0200) Subject: collectd.conf(5): Moved information about ``special'' plugins from collectd(1) to... X-Git-Tag: collectd-4.0.0-rc10~6 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=f6a1cf3fd2f9abe80d96e60dc97afc941fd84b7f;p=collectd.git collectd.conf(5): Moved information about ``special'' plugins from collectd(1) to here. --- diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 5531a124..45f14f01 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -79,7 +79,11 @@ a value higher than the number of plugins you've loaded is totally useless. =head1 PLUGIN OPTIONS Some Plugins may register own options. These options must be inclosed in a -C-Section. Which options exist depends on the plugin used: +C-Section. Which options exist depends on the plugin used. Some plugins +require external configuration, too. The C, for example, +required C to be configured in the webserver you're going to +collect data from. These plugins are listed below as well, even if they don't +require any configuration within collectd's configfile. =head2 Plugin C @@ -141,6 +145,14 @@ TCP-Port to connect to. Defaults to B<3551>. =back +=head2 Plugin C + +This plugin doesn't have any options. It reads +F (for the first CPU +installed) to get the current CPU frequency. If this file does not exist make +sure B (L) or a similar tool is +installed and an "cpu governor" (that's a kernel module) is loaded. + =head2 Plugin C =over 4 @@ -234,6 +246,15 @@ Execute the executable I as user I. =head2 Plugin C +To get values from B collectd connects to B (127.0.0.1), +port B<7634/tcp>. The B and B options can be used to change these +default values, see below. C has to be running to work correctly. If +C is not running timeouts may appear which may interfere with other +statistics.. + +The B homepage can be found at +L. + =over 4 =item B I @@ -328,6 +349,17 @@ running in foreground- or non-daemon-mode. =head2 Plugin C +The C uses mbmon to retrieve temperature, voltage, etc. + +Be default collectd connects to B (127.0.0.1), port B<411/tcp>. The +B and B options can be used to change these values, see below. +C has to be running to work correctly. If C is not running +timeouts may appear which may interfere with other statistics.. + +C must be run with the -r option ("print TAG and Value format"); +Debian's F script already does this, other people +will need to ensure that this is the case. + =over 4 =item B I @@ -342,6 +374,20 @@ TCP-Port to connect to. Defaults to B<411>. =head2 Plugin C +The C requires B to be installed. It connects to the +database when started and keeps the connection up as long as possible. When the +connection is interrupted for whatever reason it will try to re-connect. The +plugin logs loud complaints in case anything goes wrong. + +This plugin issues C and evaluates C, +C and C which correspond to F, +F and F. Also, the values of +C are put in F and values of C are put +in F. Please refer to the B, +I<5.2.4. Server Status Variables> for an explanation of these values. + +Use the following options to configure the plugin: + =over 4 =item B I @@ -572,6 +618,14 @@ used. =head2 Plugin C +The C uses B to retrieve sensor-values. This means +that all the needed modules have to be loaded and lm_sensors has to be +configured (most likely by editing F. Read +L for details. + +The B homepage can be found at +L. + =over 4 =item B I @@ -626,9 +680,26 @@ L. Defaults to B<0770>. =back +=head2 Plugin C + +This plugin doesn't have any options. B support is only available for +Linux. It cannot yet be found in a vanilla kernel, though. To make use of this +plugin you need a kernel that has B support built in, i.Ee. you +need to apply the patches and compile your own kernel, which will then provide +the F filesystem that is required by this plugin. + +The B homepage can be found at L. + =head1 SEE ALSO -L +L, +L, +L, +L, +L, +L, +L, +L =head1 AUTHOR diff --git a/src/collectd.pod b/src/collectd.pod index 85fddcb2..f0ff5904 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -87,30 +87,6 @@ detail. In particular those are L, L, =head1 SPECIAL PLUGINS -=head2 apache - -This module connects to an Apache or lighttpd webserver and expects the output -produced by B. If requires B to set up the HTTP -connection and issue the request(s). The following is a sample config for the -Apache webserver. Under Apache, the use of C is mandatory. - - ExtendedStatus on - - - SetHandler server-status - - - -This plugin requires further configuration. Please read L. - -=head2 cpufreq - -This module reads F (for -the first CPU installed) to get the current CPU frequency. If this file does -not exist make sure B (L) or a -similar tool is installed and an "cpu governor" (that's kernel module) is -loaded. - =head2 email This plugin collects data indirectly by providing a UNIX socket that external @@ -134,20 +110,6 @@ Successful spam checks (e.g. "BAYES_99", "SUBJECT_DRUG_GAP_C", ...): Each line is limited to 256 characters (including the newline character). Longer lines will be ignored. -=head2 mysql - -Requires B to be installed. It connects to the database when -started and keeps the connection up as long as possible. When the connection is -interrupted for whatever reason it will try to re-connect. The syslog will -contain loud complaints in case anything goes wrong. - -This plugin issues C and evaluates C, -C and C which correspond to F, -F and F. Also, the values of -C are put in F and values of C are put -in F. Please refer to the B, -I<5.2.4. Server Status Variables> for an explanation of these values. - =head2 perl The C includes a Perl-interpreter in collectd and provides @@ -275,61 +237,11 @@ The message is passed to all log-callbacks that are registered with collectd. =back -=head2 sensors - -The B module uses lm_sensors to retrieve sensor-values. This means -that all the needed modules have to be loaded and lm_sensors has to be -configured (most likely by editing F. Read -L for details. - -The B homepage can be found at -L. - -=head2 mbmon - -The B module uses mbmon to retrieve temperature, voltage, etc. - -collectd connects to B (127.0.0.1), port B<411/tcp>. -The B and B options can be used to change these -default values. See L for details. C has to be -running to work correctly. If C is not running timeouts may appear -which may interfere with other statistics.. - -C must be run with the -r option ("print TAG and Value format"); -Debian's /etc/init.d/mbmon script already does this, other people -will need to ensure that this is the case. - -=head2 hddtemp - -To get values from B collectd connects to B (127.0.0.1), -port B<7634/tcp>. The B and B options can be used to change these -default values. See L for details. C has to be -running to work correctly. If C is not running timeouts may appear -which may interfere with other statistics.. - -The B homepage can be found at -L. - -=head2 vserver - -B support is only available for Linux. It cannot yet be found in a -vanilla kernel, though. To make use of this plugin you need a kernel that has -B support built in, i.e. you need to apply the patches and compile -your own kernel, which will then provide the /proc/virtual filesystem that is -required by this plugin. - -The B homepage can be found at L. - =head1 SEE ALSO L, L, L, -L, -L, -L, -L, -L, L =head1 AUTHOR