X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=0ffd48540ea1e782450cce1cd1d92c27f8bd059a;hb=1aaedbca424b623f83a4f6cf837cf91574fe0e67;hp=a1846003ae8a91e8bd741b6ed6edbef6bfd33e9c;hpb=98229d2c767c2acb9850ac0468144b73c25c75d5;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index a1846003..0ffd4854 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -1019,12 +1019,12 @@ 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 will complaint loudly 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. +This plugin issues the MySQL C command and collects information +about MySQL network traffic, executed statements, requests, the query cache +and threads by evaluating the C, C, +C, C and C return values. Please refer to the +B, I<5.1.6. Server Status Variables> for an +explanation of these values. Use the following options to configure the plugin: @@ -1036,7 +1036,9 @@ Hostname of the database server. Defaults to B. =item B I -Username to use when connecting to the database. +Username to use when connecting to the database. The user does not have to be +granted any privileges (which is synonym to granting the C privilege). +Any existing MySQL user will do. =item B I @@ -1824,6 +1826,15 @@ 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. +=item B I I + +Similar to the B option this allows to select more detailed +statistics of processes matching the specified I (see L for +details). The statistics of all matching processes are summed up and +dispatched to the daemon using the specified I as an identifier. This +allows to "group" several processes together. I must not contain +slashes. + =back =head2 Plugin C @@ -2041,16 +2052,16 @@ user using (extended) regular expressions, as described in L. Instance "exim" - Regex "S=([1-9][0-9]*)" - DSType "CounterAdd" - Type "ipt_bytes" - Instance "total" + Regex "S=([1-9][0-9]*)" + DSType "CounterAdd" + Type "ipt_bytes" + Instance "total" - Regex "\\" - DSType "CounterInc" - Type "counter" - Instance "local_user" + Regex "\\" + DSType "CounterInc" + Type "counter" + Instance "local_user" @@ -2381,7 +2392,7 @@ information. Instance "cached" - WarningMin 100000000 + WarningMin 100000000 @@ -2623,10 +2634,31 @@ plugins to be loaded: =over 4 +=item B + +Signals the "return" condition. This causes the current chain to stop +processing the value and returns control to the calling chain. The calling +chain will continue processing targets and rules just after the B target +(see below). This is very similar to the B target of iptables, see +L. + +This target does not have any options. + +Example: + + Target "return" + =item B -Does nothing except returning with the stop condition, causing processing of -the current chain to be aborted. +Signals the "stop" condition, causing processing of the value to be aborted +immediately. This is similar to the B target of iptables, see +L. + +This target does not have any options. + +Example: + + Target "stop" =item B @@ -2641,10 +2673,6 @@ Available options: Name of the write plugin to which the data should be sent. This option may be given multiple times to send the data to more than one write plugin. -Example: - - Target "stop" - =back If no plugin is explicitly specified, the values will be sent to all available @@ -2661,6 +2689,8 @@ Example: Starts processing the rules of another chain. If the end of that chain is reached, or a stop condition is encountered, processing will continue right after the B target, i.Ee. with the next target or the next rule. +This is similar to the B<-j> command line option of iptables, see +L. Available options: @@ -2680,22 +2710,6 @@ Example: =back -=head2 Backwards compatibility - -If you use collectd with an old configuration, i.Ee. one without a -B block, it will behave as it used to. This is equivalent to the -following configuration: - - - Target "write" - - -If you specify a B block anywhere, the B target will not be added -anywhere and you will have to make sure that it is called where appropriate. We -suggest to add the above snippet as default target to your main chain. - -TODO: Notifications will be implemented using chains, too. Describe that here! - =head2 Available matches =over 4 @@ -2731,12 +2745,84 @@ Example: Plugin "^foobar$" +=item B + +Matches the actual value of data sources against given minimumE/ maximum +values. If a data-set consists of more than one data-source, all data-sources +must match the specified ranges for a positive match. + +Available options: + +=over 4 + +=item B I + +Sets the smallest value which still results in a match. If unset, behaves like +negative infinity. + +=item B I + +Sets the largest value which still results in a match. If unset, behaves like +positive infinity. + +=item B B|B + +Inverts the selection. If the B and B settings result in a match, +no-match is returned and vice versa. + +=back + +Either B or B, but not both, may be unset. + +Example: + + # Match all values smaller than or equal to 100. + + Max 100 + + =back =head2 Available targets =over 4 +=item B + +Replaces parts of the identifier using regular expressions. + +Available options: + +=over 4 + +=item B I I + +=item B I I + +=item B I I + +=item B I I + +Match the appropriate field with the given regular expression I. If the +regular expression matches, that part that matches is replaced with +I. If multiple places of the input buffer match a given regular +expression, only the first occurrence will be replaced. + +You can specify each option multiple times to use multiple regular expressions +one after another. + +=back + +Example: + + + # Replace "example.net" with "example.com" + Host "\\" "example.com" + + # Strip "www." from hostnames + Host "\\ + =item B Sets part of the identifier of a value to a given string. @@ -2768,6 +2854,22 @@ Example: =back +=head2 Backwards compatibility + +If you use collectd with an old configuration, i.Ee. one without a +B block, it will behave as it used to. This is equivalent to the +following configuration: + + + Target "write" + + +If you specify a B block anywhere, the B target will not be added +anywhere and you will have to make sure that it is called where appropriate. We +suggest to add the above snippet as default target to your main chain. + +TODO: Notifications will be implemented using chains, too. Describe that here! + =head2 Examples Ignore all values, where the hostname does not contain a dot, i.Ee. can't @@ -2791,10 +2893,12 @@ L, L, L, L, +L, L, L, L, L, +L, L, L