X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=5f9538b7233e70771848103cef7c7b20b06bce16;hp=16397e21d78e2d50024ee8f549e68d00d72dcdca;hb=d1483d2e2a9116c233aeaceba99fa58a7e6bdc87;hpb=89b7a6dfb77e5529e5089bf6593ed9fd83202429 diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 16397e21..5f9538b7 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -1,3 +1,5 @@ +=encoding UTF-8 + =head1 NAME collectd.conf - Configuration for the system statistics collection daemon B @@ -7,11 +9,15 @@ collectd.conf - Configuration for the system statistics collection daemon B + Interval 3600 + + LoadPlugin ping - Host "example.org" Host "provider.net" @@ -73,6 +79,7 @@ options are allowed inside a B block: Globals true + Interval 10 =over 4 @@ -82,15 +89,25 @@ options are allowed inside a B block: If enabled, collectd will export all global symbols of the plugin (and of all libraries loaded as dependencies of the plugin) and, thus, makes those symbols available for resolving unresolved symbols in subsequently loaded plugins if -that is supported by your system. By default, this is disabled. +that is supported by your system. -This is useful (or possibly even required), e.Eg., when loading a plugin -that embeds some scripting language into the daemon (e.Eg. the C -or C plugins). Scripting languages usually provide means to load +This is useful (or possibly even required), e.g., when loading a plugin that +embeds some scripting language into the daemon (e.g. the I and +I). Scripting languages usually provide means to load extensions written in C. Those extensions require symbols provided by the -interpreter, which is loaded as a dependency of the respective collectd -plugin. See the documentation of those plugins (e.Eg., -L or L) for details. +interpreter, which is loaded as a dependency of the respective collectd plugin. +See the documentation of those plugins (e.g., L or +L) for details. + +By default, this is disabled. As a special exception, if the plugin name is +either C or C, the default is changed to enabled in order to keep +the average user from ever having to deal with this low level linking stuff. + +=item B I + +Sets a plugin-specific interval for collecting metrics. This overrides the +global B setting. If a plugin provides own support for specifying an +interval, that setting will take precedence. =back @@ -104,6 +121,29 @@ use statements like the following: Include "/etc/collectd.d/*.conf" +Starting with version 5.3, this may also be a block in which further options +affecting the behavior of B may be specified. The following option is +currently allowed: + + + Filter "*.conf" + + +=over 4 + +=item B I + +If the C function is available on your system, a shell-like wildcard +I may be specified to filter which files to include. This may be used +in combination with recursively including a directory to easily be able to +arbitrarily mix configuration files and other documents (e.g. README files). +The given example is similar to the first example above but includes all files +matching C<*.conf> in any subdirectory of C: + + Include "/etc/collectd.d" "*.conf" + +=back + If more than one files are included by a single B option, the files will be included in lexicographical order (as defined by the C function). Thus, you can e.Eg. use numbered prefixes to specify the @@ -151,14 +191,20 @@ missing when no update has been received for twice the update interval. Since this setting uses iterations, the maximum allowed time without update depends on the I information contained in each value list. This is used in the I configuration to dispatch notifications about missing values, -see L<"THRESHOLD CONFIGURATION"> below. +see L for details. =item B I Number of threads to start for reading plugins. The default value is 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. +long time to read. Mostly those are plugins that do network-IO. Setting this to +a value higher than the number of registered read callbacks is not recommended. + +=item B I + +Number of threads to start for dispatching value lists to write plugins. The +default value is B<5>, but you may want to increase this if you have more than +five plugins that may take relatively long to write to. =item B I @@ -169,13 +215,8 @@ hostname will be determined using the L system call. If B is determined automatically this setting controls whether or not the daemon should try to figure out the "fully qualified domain name", FQDN. -This is done using a lookup of the name returned by C. - -Using this feature (i.Ee. setting this option to B) is recommended. -However, to preserve backwards compatibility the default is set to B. -The sample config file that is installed with Cinstall> includes a -line which sets this option, though, so that default installations will have -this setting enabled. +This is done using a lookup of the name returned by C. This option +is enabled by default. =item B I @@ -194,12 +235,360 @@ 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. +require any configuration within collectd's configuration file. 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 + +The I makes it possible to aggregate several values into +one using aggregation functions such as I, I, I and I. +This can be put to a wide variety of uses, e.g. average and total CPU +statistics for your entire fleet. + +The grouping is powerful but, as with many powerful tools, may be a bit +difficult to wrap your head around. The grouping will therefore be +demonstrated using an example: The average and sum of the CPU usage across +all CPUs of each host is to be calculated. + +To select all the affected values for our example, set C and +C. The other values are left unspecified, meaning "all values". The +I, I, I, I and I options +work as if they were specified in the C clause of an C