X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.pod;h=0a3b91f46050dbef95fc48402607be20e5c446a5;hb=4958c31de9baec617b2973e2d602e76da7196362;hp=de944b49ef522b9c32d6456edf10b82d310c8ec6;hpb=62c921dc9a19bd92fc63162108ef8cde49dadfdf;p=collectd.git diff --git a/src/collectd.pod b/src/collectd.pod index de944b49..0a3b91f4 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -82,6 +82,10 @@ Network traffic (I) Number of users logged into the system (I) +=item + +System ressources used by VServers (I) + =back =head1 OPTIONS @@ -106,6 +110,82 @@ 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. + +=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 RRD FILES The RRD files are created automatically with the following RRAs: @@ -307,86 +387,37 @@ The DS'es depend on the module creating the RRD files: DS:users:GAUGE:25:0:65535 -=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. +=item VServer load (FxidE>/load.rrd>) -=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. + DS:shortterm:GAUGE:25:0:100 + DS:midterm:GAUGE:25:0:100 + DS:longterm:GAUGE:25:0:100 -=head2 mysql +=item VServer threads (FxidE>/threads.rrd>) -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. + DS:total:GAUGE:25:0:65535 + DS:running:GAUGE:25:0:65535 + DS:uninterruptible:GAUGE:25:0:65535 + DS:onhold:GAUGE:25:0:65535 -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. +=item VServer network traffic (FxidE>/traffic-InameE>.rrd>) -=head2 sensors + DS:incoming:COUNTER:25:0:9223372036854775807 + DS:outgoing:COUNTER:25:0:9223372036854775807 + DS:failed:COUNTER:25:0:9223372036854775807 -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. +=item VServer processes (FxidE>/vs_processes.rrd>) -The B homepage can be found at -L. + DS:total:GAUGE:25:0:65535 -=head2 hddtemp +=item VServer memory usage (FxidE>/vs_memory.rrd>) -To get values from B collectd connects to B (127.0.0.1), -port B<7634/tcp>. hddtemp has to be running to work correctly. If hddtemp is -not running timeouts may appear which may interfere with other statistics.. + DS:vm:GAUGE:25:0:9223372036854775807 + DS:vml:GAUGE:25:0:9223372036854775807 + DS:rss:GAUGE:25:0:9223372036854775807 + DS:anon:GAUGE:25:0:9223372036854775807 -The B homepage can be found at -L. +=back =head1 SEE ALSO