X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=879c2c3455e44c51dff2b7d828651ba9ee1c764f;hb=2b6176cab4f092354177473bbc74c5cdc2eaa2ec;hp=aa4799a48ac0dad96b5912cf3e0b4d89e37486d7;hpb=e2ef3574e5ebc05c822c184f4047c0475d079f0b;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index aa4799a4..879c2c34 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -4,105 +4,94 @@ collectd.conf - Configuration for the system statistics collection daemon B - Host example.org - Host provider.net + Host "example.org" + Host "provider.net" =head1 DESCRIPTION This config file controls how the system statistics collection daemon -B behaves. The most significant options are B, which controlls -if the daemon will act as client, server or will be independent in local mode, -and B which controls which plugins to load. +B behaves. The most significant option is B, which +controls which plugins to load. These plugins ultimately define collectd's +behavior. The syntax of this config file is similar to the config file of the famos -B. Each line containes either a key-value-pair or a +B. Each line contains either a key-value-pair or a section-start or -end. Empty lines and everything after the hash-symbol `#' is -ignored. +ignored. Values are either string, enclosed in double-quotes, +(floating-point-)numbers or a boolean expression, i.Ee. either B or +B. String containing of only alphanumeric characters and underscores do +not need to be quoted. + +Please note that B in the library used by collectd to read the +configfile, that will lead to all lines with trailing whitespaces to be +ignored. This problem has been solved in collectdE4.0 and later. =head1 GLOBAL OPTIONS =over 4 -=item B (B|B|B|B) +=item B I -Sets the operating mode. See the section B in L for a -description. This option determines which other options are allowed. Defaults -to B. +Sets the base directory. This is the directory beneath all RRD-files are +created. Possibly more subdirectories are created. This is also the working +directory for the daemon. =item B I Loads the plugin I. There must be at least one such line or B -will be mostly useless. The names of the plugins are listed in L. +will be mostly useless. =item B I Sets where to write the PID file to. This file is overwritten when it exists and deleted when the program ist stopped. Some init-scripts might override this -setting using the B<-P> commandline option. Available in B. +setting using the B<-P> commandline option. -=item B I +=item B I -Sets the data directory. This is the directory beneath all RRD-files are -created. Possibly more subdirectories are created. This is also the working -directory for the daemon. Available in B, though the B mode -won't write to this directory. +Path to the plugins (shared objects) of collectd. -=item B I +=item B I -Sets the file to write debugging output to. This is only used if compiled with -debugging enabled. It's ignored otherwise. Available in B. +Set the file that contains the data-set descriptions. -=item B I [I] +=item B I -=item B I [I] +Configures the interval in which to query the read plugins. Obviously smaller +values lead to a higher system load produces by collectd, while higher values +lead to more coarse statistics. -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. +=item B I -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. - -=item B I<1-255> - -Set the time-to-live of sent packets. This applies to all, unicast and -multicast, and IPv4 and IPv6 packets. The default is to not change this value. -That means that multicast packets will be sent with a TTL of C<1> (one) on most -operating systems. +Number of threads to start for reading plugins. The default value if B<5>, but +you may want to increase this if you have more than five plugins that take a +long time to read. Mostly those are plugin that do network-IO. Setting this to +a value higher than the number of plugins you've loaded is totally useless. =back =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: +Some Plugins may register own options. These options must be enclosed in a +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. + +A list of all plugins and a short summary for each plugin can be found in the +F file shipped with the sourcecode and hopefully binary packets as +well. =head2 Plugin C @@ -118,6 +107,10 @@ the following snipped to base your Apache config upon: +Since its C module is very similar to Apache's, B is +also supported. It introduces a new field, called C, to count the +number of currently connected clients. This field is also supported. + The following options are accepted by the C-plugin: =over 4 @@ -139,7 +132,7 @@ Optional password needed for authentication. =item B I File that holds one or more SSL certificates. If you want to use HTTPS you will -possibly need this option. What CA certificates come bundeled with C +possibly need this option. What CA certificates come bundled with C and are checked by default depends on the distribution you use. =back @@ -160,6 +153,25 @@ 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 + +=item B I + +Set the directory to store RRD-files under. Per default RRD-files are generated +beneath the daemon's working directory, i.Ee. the B. + +=back + =head2 Plugin C =over 4 @@ -180,7 +192,7 @@ Select partitions based on the filesystem type. Invert the selection: If set to true, all partitions B the ones that match any one of the criteria are collected. By default only selected -partitions are collected if a selection is made. If no selection is conifured +partitions are collected if a selection is made. If no selection is configured at all, B partitions are selected. =back @@ -226,8 +238,31 @@ at most B<16384> to prevent typos and dumb mistakes. =back +=head2 Plugin C + +Please make sure to read L before using this plugin. It +contains valuable information on when the executable is executed and the +output that is expected from it. + +=over 4 + +=item B I I + +Execute the executable I as user I. + +=back + =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 @@ -240,22 +275,127 @@ TCP-Port to connect to. Defaults to B<7634>. =back -=head2 Plugin C +=head2 Plugin C + +=over 4 + +=item B I + +Select this interface. By default these interfaces will then be collected. For +a more detailed description see B below. + +=item B I|I + +If no configuration if given, the B-plugin will collect data from +all interfaces. This may not be practical, especially for loopback- and +similar interfaces. Thus, you can use the B-option to pick the +interfaces you're interested in. Sometimes, however, it's easier/preferred +to collect all interfaces I a few ones. This option enables you to +do that: By setting B to I the effect of +B is inversed: All selected interfaces are ignored and all +other interfaces are collected. + +=back + +=head2 Plugin C + +=over 4 + +=item B I I [I [I]] + +Select the rules to count. If only I
and I are given, this plugin +will collect the counters of all rules which have a comment-match. The comment +is then used as type-instance. + +If I or I is given, only the rule with the matching comment or +the Ith rule will be collected. Again, the comment (or the number) will be +used as the type-instance. + +If I is supplied, it will be used as the type-instance instead of the +comment or the number. + +=back + +=head2 Plugin C + +=over 4 + +=item B I + +Select this irq. By default these irqs will then be collected. For a more +detailed description see B below. + +=item B I|I + +If no configuration if given, the B-plugin will collect data from all +irqs. This may not be practical, especially if no interrupts happen. Thus, you +can use the B-option to pick the interrupt you're interested in. +Sometimes, however, it's easier/preferred to collect all interrupts I a +few ones. This option enables you to do that: By setting B to +I the effect of B is inversed: All selected interrupts are ignored +and all other interrupts are collected. + +=back + +=head2 Plugin C + +=over 4 + +=item B B + +Sets the log-level. If, for example, set to B, then all events with +severity B, B, or B will be written to the logfile. + +=item B I + +Sets the file to write log messages to. The special strings B and +B can be used to write to the standard output and standard error +channels, respectively. This, of course, only makes much sense when collectd is +running in foreground- or non-daemon-mode. + +=back + +=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 -Hostname of the host running B. Defaults to B. +Hostname to connect to. Defaults to B<127.0.0.1>. =item B I -UDP-Port to connect to. Defaults to B<123>. +TCP-Port to connect to. Defaults to B<411>. =back =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 @@ -272,11 +412,114 @@ Password needed to log into the database. =item B I -Select this database. Defaults to I which is a perfecly reasonable +Select this database. Defaults to I which is a perfectly reasonable option for what this plugin does. =back +=head2 Plugin C + +=over 4 + +=item B I [I] + +=item B I [I] + +The B statement sets the server to send datagrams B. The statement +may occur multiple times to send each datagram to multiple destinations. + +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 default IPv6 +multicast group and the default IPv4 multicast group. If no B statement +is found the client will try to send data to the IPv6 multicast group first. If +that fails 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 omitted the +default port B<25826> is assumed. + +=item B I<1-255> + +Set the time-to-live of sent packets. This applies to all, unicast and +multicast, and IPv4 and IPv6 packets. The default is to not change this value. +That means that multicast packets will be sent with a TTL of C<1> (one) on most +operating systems. + +=item B I + +If set to I, write packets that were received via the network plugin to +the sending sockets. This should only be activated when the B- and +B-statements differ. Otherwise packets may be send multiple times to +the same multicast group. While this results in more network traffic than +necessary it's not a huge problem since the plugin has a duplicate detection, +so the values will not loop. + +=item B I + +For each host/plugin/type combination the C caches the time of +the last value being sent or received. Every I seconds the plugin +searches and removes all entries that are older than I seconds, thus +freeing the unused memory again. Since this process is somewhat expensive and +normally doesn't do much, this value should not be too small. The default is +1800 seconds, but setting this to 86400 seconds (one day) will not do much harm +either. + +=back + +=head2 Plugin C + +=over 4 + +=item B I + +Hostname of the host running B. Defaults to B. + +=item B I + +UDP-Port to connect to. Defaults to B<123>. + +=back + +=head2 Plugin C + +=over 4 + +=item B IB<@>I[B<:>I] + +Add a UPS to collect data from. The format is identical to the one accepted by +L. + +=back + +=head2 Plugin C + +=over 4 + +=item B I + +Loads the Perl plugin I. This does basically the same as B would +do in a Perl program. + +=item B I + +Prepends IB<::> to all plugin names loaded after this option. This is +provided for convenience to keep plugin names short. + +=item B I + +Adds I to the B<@INC> array. This is the same as using the B<-IDir> +command line option or B in the source code. + +=back + =head2 Plugin C =over 4 @@ -292,92 +535,179 @@ Sets the Time-To-Live of generated ICMP packets. =back +=head2 Plugin C + +=over 4 + +=item B I + +Select more detailed statistics of processes matching this name. The statistics +collected for these selected processes are size of the resident segment size +(RSS), user- and system-time used, number of processes and number of threads, +and minor and major pagefaults. + +=back + +=head2 Plugin C + +You can use the settings B, B, B, and B to +finetune your RRD-files. Please read L if you encounter problems +using these settings. If you don't want to dive into the depths of RRDTool, you +can safely ignore these settings. + +=over 4 + +=item B I + +Set the directory to store RRD-files under. Per default RRD-files are generated +beneath the daemon's working directory, i.Ee. the B. + +=item B I + +Sets the stepsize of newly created RRD-files. Ideally (and per default) this +setting is identical to the global B-option and should not be +smaller. If unsure, don't set this option. + +=item B I + +Sets the heartbeat of newly created RRD-files. Ideally this setting is bigger +than the B-setting, by default it's twice the B-setting. If +unsure, don't set this option. + +=item B I + +The C calculates the number of PDPs per CDP based on the +B, this setting and a timespan. This plugin creates RRD-files with +three times five RRAs, i. e. five RRAs with the CFs B, B, and +B. The five RRAs are optimized for graphs covering one hour, one day, one +week, one month, and one year. + +So for each timespan, it calculates how many PDPs need to be consolidated into +one CDP by calculating: + number of PDPs = timespan / (stepsize * rrarows) + +Bottom line is, set this no smaller than the width of you graphs in pixels. The +default is 1200. + +=item B I + +Adds an RRA-timespan, given in seconds. Use this option multiple times to have +more then one RRA. If this option is never used, the built-in default of (3600, +86400, 604800, 2678400, 31622400) is used. + +For more information on how RRA-sizes are calculated see B above. + +=item B I + +Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option. + +=item B I + +When the C uses a cache (by setting B, see below) +it writes all values for a certain RRD-file if the oldest value is older than +(or equal to) the number of seconds specified. If some RRD-file is not updated +anymore for some reason (the computer was shut down, the network is broken, +etc.) some values may still be in the cache. If B is set, then the +entire cache is searched for entries older than B seconds and +written to disk every I seconds. Since this is kind of expensive and +does nothing under normal circumstances, this value should not be too small. +900 seconds might be a good value, though setting this to 7200 seconds doesn't +normally do much harm either. + +=item B I + +If this option is set to a value greater than zero, the C will +save values in a cache, as described above. Writing multiple values at once +reduces IO-operations and thus lessens the load produced by updating the files. +The tradeoff is that the graphs kind of "drag behind" and that more memory is +used. + +=back + =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|I - -If set to I this option switches on the extended sensors and RRD-files -naming. This option exists to preserve backwards compatibility. It is -recommended that you set this option to I. The default is I to -maintain compatibility only. - -Sensors get names like I (e.g. -I) and RRD files are therefore stored in a -standalone directory inside the B directory and get names like -I (e.g. -I). - -The B option breaks the compatibility with previous -sensors and RRD files naming and the place where RRDs are stored. If you turn -it on, the plugin will create new RRD files in a standalone directory inside -the B directory and without previous history. You can rename ``old'' -RRD-files to preserve already collected statistics, because the file layout -hasn't changed. If you have two chips of the same type, you need to use -B in order to collect information from both chips. - -If not set or set to I, the extended naming is not active. Sensors get -names like I (e.g. I) and RRD files are stored in the -main B directory and get names like I (e.g. -I). You simply continue using the plugin the old way -and additionally also getting data for newly added sensors in this mode. - -=item B I or B I - -Both option modes select the name of the sensor which you want to collect. -The naming scheme is dependent on the state of the B -option (see previous option). Both option modes can also deselect the -sensor according to the B option (see below). - -For example the option "B I" will cause the collectd -to gather data for the voltage sensor I of the I chip in case -of the B option is set to I. - -And likewise the option "B I" will -cause the collectd to gather data for the voltage sensor I of the I -on the isa bus at the address 0290 in case of the B -option set to I. +=item B I + +Selects the name of the sensor which you want to collect or ignore, depending +on the B below. For example, the option "B +I" will cause collectd to gather data for the +voltage sensor I of the I on the isa bus at the address 0290. =item B I|I -If no configuration if given, the B-plugin will collect data from -all sensors. This may not be practical, especially for uninteresting sensors. -Thus, you can use the B-option to pick the sensors you're -interested in. Sometimes, however, it's easier/prefered to collect all -sensors I a few ones. This option enables you to -do that: By setting B to I the effect of -B is inversed: All selected sensors are ignored and all -other sensors are collected. +If no configuration if given, the B-plugin will collect data from all +sensors. This may not be practical, especially for uninteresting sensors. +Thus, you can use the B-option to pick the sensors you're interested +in. Sometimes, however, it's easier/preferred to collect all sensors I a +few ones. This option enables you to do that: By setting B to +I the effect of B is inversed: All selected sensors are ignored +and all other sensors are collected. + +=back + +=head2 Plugin C + +=over 4 + +=item B B -back +Sets the log-level. If, for example, set to B, then all events with +severity B, B, or B will be submitted to the +syslog-daemon. =back -=head2 Plugin C +=head2 Plugin C =over 4 -=item B I +=item B I -Select this interface. By default these interfaces will then be collected. For a more detailed description see B below. +Sets the socket-file which is to be created. -=item B I|I +=item B I -If no configuration if given, the B-plugin will collect data from -all interfaces. This may not be practical, especially for loopback- and -similar interfaces. Thus, you can use the B-option to pick the -interfaces you're interested in. Sometimes, however, it's easier/prefered -to collect all interfaces I a few ones. This option enables you to -do that: By setting B to I the effect of -B is inversed: All selected interfaces are ignored and all -other interfaces are collected. +If running as root change the group of the UNIX-socket after it has been +created. Defaults to B. + +=item B I + +Change the file permissions of the UNIX-socket after it has been created. The +permissions must be given as a numeric, octal value as you would pass to +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