X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=f2a971f611820bfad40af0f67dca7ffa774ad656;hb=1115921a0d8f73c08fd505344af4266105e1155d;hp=c025f94928552961b2056e70029d2694a128343e;hpb=7a6887ad7eef33e04bcb0720c213d05fd9be8a59;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index c025f949..f2a971f6 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" @@ -64,16 +70,33 @@ 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. +Loads the plugin I. This is required to load plugins, unless the +B option is enabled (see below). Without any loaded plugins, +I will be mostly useless. -Starting with collectd 4.9, this may also be a block in which further options -affecting the behavior of B may be specified. The following -options are allowed inside a B block: +Only the first B statement or block for a given plugin name has any +effect. This is useful when you want to split up the configuration into smaller +files and want each file to be "self contained", i.e. it contains a B +block I then appropriate B statement. The downside is that if +you have multiple conflicting B blocks, e.g. when they specify +different intervals, only one of them (the first one encountered) will take +effect and all others will be silently ignored. - - Globals true - +B may either be a simple configuration I or a I +with additional options, affecting the behavior of B. A simple +statement looks like this: + + LoadPlugin "cpu" + +Options inside a B block can override default settings and +influence the way plugins are loaded, e.g.: + + + Globals true + Interval 60 + + +The following options are valid inside B blocks: =over 4 @@ -96,9 +119,28 @@ 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 -=item B I +=item B B|B + +When set to B (the default), each plugin needs to be loaded explicitly, +using the B statement documented above. If a +BPluginE...E> block is encountered and no configuration +handling callback for this plugin has been registered, a warning is logged and +the block is ignored. + +When set to B, explicit B statements are not required. Each +BPluginE...E> block acts as if it was immediately preceded by a +B statement. B statements are still required for +plugins that don't provide any configuration, e.g. the I. + +=item B I [I] If I points to a file, includes that file. If I points to a directory, recursively includes all files within that directory and its @@ -108,6 +150,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 @@ -161,8 +226,31 @@ see L for details. 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 +=item B I + +Default value for high limit is 0 (no limit). +Default value for low limit is 50% of high limit. + +When the write queue size becomes bigger than the high limit, values I be dropped. +When the write queue size is between low and high, values I be dropped (depending +on the queue size) + +If high limit is set to 0, there is no limit. This is the default. +If high limit is set, but not low limit, low will be computed as 50% of high. + +If you do not want to randomly drop values when the queue size is between low +and high value, set the same value for low and high. When low=high and when the +queue size is bigger, values are just dropped until the queue size becomes smaller. =item B I @@ -193,12 +281,183 @@ 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