From 95d4c293e85934098219c16f2db235f2973210c2 Mon Sep 17 00:00:00 2001 From: octo Date: Sun, 29 Jan 2006 20:43:56 +0000 Subject: [PATCH] Updated the manpages. Changed the bits about operating modes and network stuff.. --- src/collectd.conf.pod | 31 ++++++--- src/collectd.pod | 147 +++++++++++++++++++----------------------- 2 files changed, 88 insertions(+), 90 deletions(-) diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index d65c192b..88800853 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -64,18 +64,31 @@ won't write to this directory. Sets the file to write debugging output to. This is only used if compiled with debugging enabled. It's ignored otherwise. Available in B. -=item B I +=item B I [I] -The server to send data to. B Maybe a better name -for this was B, since I plan on detecting multicast groups -automatically. On the other hand a extra MulticastGroup-option would be of -interest for the server process. Anyhow, right now this is available for the -B mode only. +=item B I [I] -=item B I +In B the B statement sets the server to send datagrams to. +The statement may occur multiple times to send each datagram to multiple +destinations. -(UDP-)Port to send packages to or to bind to and wait for packages. This option -is available in the B and B mode. +In B the B statement sets the interfaces to bind to. When +multiple statements are found the daemon will bind to multiple interfaces. + +The argument I may be a hostname, an IPv4 address or an IPv6 address. If +the argument is a multicast address the daemon will join that multicast group. + +If no B statement is found the server tries join both, the IPv6 +multicast group and the IPv4 multicast group. If no B statement is +found the client will try to send data to the IPv6 multicast group first. If +that failes the client will try the IPv4 multicast group. + +The default IPv6 multicast group is C. The default IPv4 +multicast group is C<239.192.74.66>. + +The optional I argument sets the port to use. It can either be given +using a numeric port number or a service name. If the argument is omited the +default port B<25826> is assumed. =back diff --git a/src/collectd.pod b/src/collectd.pod index d1ffa53b..db0e8ba4 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -106,6 +106,72 @@ Output usage information and exit. =back +=head1 MODES + +collectd can operate in three different operating modes. The modes are +described below. + +The simplest mode is the so called B. Data is collected locally and +written in RRD files that reside in I. This is the default mode when +collectd is linked against C. + +The other two modes, B and B, are used to send data +over a network and receive it again. + +In B the daemon collectd the data locally and send it's result to +one or more network addresses. No RRD files are written in this case. This is +the only mode available if collectd is not linked against C. + +If started in B the daemon will listen on one or more interfaces +and write the data it receives to RRD files. No data is collected locally. + +Please refer to L for the configuration options and default +values. + +=head1 SPECIAL PLUGINS + +=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. + +=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 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 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. + =head1 RRD FILES The RRD files are created automatically with the following RRAs: @@ -309,87 +375,6 @@ The DS'es depend on the module creating the RRD files: =back -=head1 MODES - -By default collectd starts in the so called I which is not very -interesting. It collects data and writes it into RRD files in -F. There's nothing special so I won't discuss that in more -detail.. - -Please be aware that B. A -later declaration overrides earlier ones. I will start in -server-mode. If you want statistics of the server too you will have to start a -client process as well. - -Starting with version 3 collectd may send data over a network. As common with -network stuff there are two modes: A I and a I. Since one -usually has many senders and only a few listeners the sender is also called -I (using the option B<-c>) and the listener is called I (using -the option B<-s>). - -Communication happends using the (IPv4) multicast group B<239.192.74.66> and -packets sent to the port B<25826/udp>. Every ten seconds the I queries -all the modules and sends the collected data to the multicast group. The -I subscribes to the multicast group upon startup and then waits for -incoming packets. As it receives the packets it checks wether it has the -neccessary module and, if found, writes the data to an RRD file, creating -directories and files as needed. - -The multicast group used is within the I as defined -by L. Addresses within that space are meant to be routed within an AS -but not to the outside. However collectd cannot control this and won't try. So -it's totally up to you to secure your net. - -The UDP port used has been checked to not be assigned by the IANA. - -On multi-homed machines you may need to add a route to the multicast net -(B<224.0.0.0/4>) if multicast packages take the wrong interface. The listener -on the other hand listens on B interfaces. - -=head1 SPECIAL PLUGINS - -=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. - -=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 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 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. - =head1 SEE ALSO L, L, L, L, -- 2.30.2