X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.pod;h=0bf8299e53bae85810dac47078151b941fae3d7f;hb=46ed2804b39e77f7a0277f5188b7a82b1bead88d;hp=55a99edc2a6e0dd0e2530deb8d4c0c589e1fdbdd;hpb=8d313c990e29e6c8c14b3e9d921b44b54323a65d;p=collectd.git diff --git a/src/collectd.pod b/src/collectd.pod index 55a99edc..0bf8299e 100644 --- a/src/collectd.pod +++ b/src/collectd.pod @@ -16,10 +16,18 @@ settings. The following features may be available: =item +Battery status (I) + +=item + CPU utilization (I) =item +Mountpoint usage (I) + +=item + Disk and partition usage/throughput (I) =item @@ -36,6 +44,10 @@ Memory usage (I) =item +MySQL statistics (I) + +=item + NFS utilization (I, Linux only) =item @@ -70,26 +82,21 @@ Network traffic (I) Number of users logged into the system (I) +=item + +System ressources used by VServers (I) + =back =head1 OPTIONS =over 4 -=item B<-c> +=item B<-C> Iconfig-fileE> -Start in client (transmitter) mode. Data will be sent to the multicast group. -See L<"MODES">. - -=item B<-d> IdirectoryE> - -Sets the directory collectd should work in. All F<.rrd>-files are created in -this directory. Per default this is F. - -=item B<-P> IdirectoryE> - -Sets the directory collectd should look for plugins in. Per default this is -F. +Specify an alternative config file. This is the place to go when you wish to +change B's behavior. The path may be relative to the current working +directory. =item B<-f> @@ -101,52 +108,147 @@ thought for 'supervisioning' init replacements such as I. Output usage information and exit. -=item B<-l> +=back + +=head1 MODES -Start in local mode. This is the default. No data will be sent or read to/from -the network. Information will be read and written by the same process. See -L<"MODES">. +collectd can operate in three different operating modes. The modes are +described below. -=item B<-p> IhostE> +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. -Sets the host to ping periodically. This option may be given more than once to -ping multiple hosts. If this option is not given at least once no host will be -pinged. +The other two modes, B and B, are used to send data +over a network and receive it again. -=item B<-s> +In B the daemon collects the data locally and sends it's results +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. -Start in server (receiver) mode. Data sent to the multicast group will be read -and stored in RRD files. See L<"MODES">. +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. -=back +Please refer to L for the configuration options and default +values. -=head1 RRD FILES +=head1 SPECIAL PLUGINS + +=head2 apache + +This module connects to an Apache 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. 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 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 RRD files are created automatically with the following RRAs: +The B homepage can be found at +L. + +=head2 vserver - RRA:AVERAGE:0.2:6:1500 - RRA:AVERAGE:0.1:180:1680 - RRA:AVERAGE:0.1:2160:1520 - RRA:MIN:0.2:6:1500 - RRA:MIN:0.1:180:1680 - RRA:MIN:0.1:2160:1520 - RRA:MAX:0.2:6:1500 - RRA:MAX:0.1:180:1680 - RRA:MAX:0.1:2160:1520 +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. -Since collectd uses a 10 second I the RRAs contain the following -timespans: +The B homepage can be found at L. - Resolution | Data points | Timespan - -----------+-------------+---------- - 60 seconds | 1500 | 25 hours - 30 minutes | 1680 | 35 days - 6 hours | 1520 | 380 days +=head1 RRD FILES + +The RRD files are created automatically. The size of the RRAs depend on the +compile time settings of I and I. With the default values (I += B<10>, I = B<1200>) the following RRAs are created: + + RRA:AVERAGE:0.1:1:8640 + RRA:AVERAGE:0.1:50:1210 + RRA:AVERAGE:0.1:223:1202 + RRA:AVERAGE:0.1:2635:1201 + RRA:MIN:0.1:1:8640 + RRA:MIN:0.1:50:1210 + RRA:MIN:0.1:223:1202 + RRA:MIN:0.1:2635:1201 + RRA:MAX:0.1:1:8640 + RRA:MAX:0.1:50:1210 + RRA:MAX:0.1:223:1202 + RRA:MAX:0.1:2635:1201 + +By default collectd uses a 10 second I. Thus the RRAs contain the +following timespans. If you've changed the I at compile time you will +have calculate resolution and timespan yourself. + + PDP per CDP | Resolution | Data points | Timespan + ------------+--------------+-------------+--------- + 1 | 10.0 seconds ! 8640 ! 1 day + 50 | 8.3 minutes | 1210 | 1 week + 223 | 37.2 minutes | 1202 | 1 month + 2635 | 7.3 hours | 1201 | 1 year The DS'es depend on the module creating the RRD files: =over 4 +=item Battery charge (FnameE>/charge.rrd>) + + DS:charge:GAUGE:25:0:U + +=item Battery current (FnameE>/current.rrd>) + + DS:current:GAUGE:25:U:U + +=item Battery voltage (FnameE>/voltage.rrd>) + + DS:voltage:GAUGE:25:U:U + =item CPU (FnumE>.rrd>) DS:user:COUNTER:25:0:100 @@ -155,6 +257,11 @@ The DS'es depend on the module creating the RRD files: DS:idle:COUNTER:25:0:100 DS:wait:COUNTER:25:0:100 +=item Mountpoints (FpathE>.rrd>) + + DS:used:GAUGE:25:0:U + DS:free:GAUGE:25:0:U + =item Diskstats (FmajorE>-IminorE>.rrd>) DS:rcount:COUNTER:25:0:U @@ -190,6 +297,25 @@ The DS'es depend on the module creating the RRD files: DS:buffers:GAUGE:25:0:9223372036854775807 DS:cached:GAUGE:25:0:9223372036854775807 +=item MySQL commands and handlers (FcommandE>.rrd> and FhandlerE>.rrd>) + + DS:value:COUNTER:25:0:U + +=item MySQL query cache (F) + + DS:hits:COUNTER:25:0:U + DS:inserts:COUNTER:25:0:U + DS:not_cached:COUNTER:25:0:U + DS:lowmem_prunes:COUNTER:25:0:U + DS:queries_in_cache:GAUGE:25:0:U + +=item MySQL threads (F) + + DS:running:GAUGE:25:0:U + DS:connected:GAUGE:25:0:U + DS:cached:GAUGE:25:0:U + DS:created:COUNTER:25:0:U + =item NFSv2 Procedures (F.rrd>) DS:null:COUNTER:25:0:U @@ -285,76 +411,42 @@ 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. +=item VServer load (FxidE>/load.rrd>) -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>). + DS:shortterm:GAUGE:25:0:100 + DS:midterm:GAUGE:25:0:100 + DS:longterm:GAUGE:25:0:100 -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. +=item VServer threads (FxidE>/threads.rrd>) -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. + DS:total:GAUGE:25:0:65535 + DS:running:GAUGE:25:0:65535 + DS:uninterruptible:GAUGE:25:0:65535 + DS:onhold:GAUGE:25:0:65535 -The UDP port used has been checked to not be assigned by the IANA. +=item VServer network traffic (FxidE>/traffic-InameE>.rrd>) -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. + DS:incoming:COUNTER:25:0:9223372036854775807 + DS:outgoing:COUNTER:25:0:9223372036854775807 + DS:failed:COUNTER:25:0:9223372036854775807 -=head1 SPECIAL MODULES +=item VServer processes (FxidE>/vs_processes.rrd>) -=head2 cpufreq + DS:total:GAUGE:25:0:65535 -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. +=item VServer memory usage (FxidE>/vs_memory.rrd>) -=head2 sensors + 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 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>. hddtemp has to be running to work correctly. If hddtemp is -not running timeouts may appear which may interfere with other statistics.. - -The B homepage can be found at -L. +=back =head1 SEE ALSO -L, L, L, L +L, L, L, L, +L =head1 AUTHOR