X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=43946bdf6b0890176b2c37dbb3fd7c186ed1af1b;hb=8692579147f7e5cfbd4168a2da926dfd20e592f4;hp=605ba14796222cf32ddc0f738c3d60d13c19802f;hpb=67a5f0bd07ca46402ad13f610bb4a154d216d50d;p=collectd.git
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 605ba147..43946bdf 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -454,7 +454,7 @@ finance page and dispatch the value to collectd.
Regex "]*> *([0-9]*\\.[0-9]+) *"
DSType "GaugeAverage"
- # Note: `stock_value' is not a standard type.
+ # Note: `stock_value' is not a standard type.
Type "stock_value"
Instance "AMD"
@@ -529,7 +529,7 @@ than those of other plugins. It usually looks something like this:
MinVersion 50000
Type "gauge"
- InstancePrefix "out_of_stock"
+ InstancePrefix "out_of_stock"
InstancesFrom "category"
ValuesFrom "value"
@@ -606,6 +606,9 @@ like this:
use a more strict database server, you may have to select from a dummy table or
something.)
+Please note that some databases, for example B, will fail if you
+include a semicolon at the end of the statement.
+
=item B I
=item B I
@@ -653,20 +656,24 @@ There must be exactly one B option inside each B block.
=item B I
-Prepends I followed by a dash I<("-")> to the type instance. See
-B on how the rest of the type instance is built.
+Prepends I to the type instance. If B (see below) is not
+given, the string is simply copied. If B is given, I and
+all strings returned in the appropriate columns are concatenated together,
+separated by dashes I<("-")>.
=item B I [I ...]
-Specifies the columns whose values will be used to create the "TypeInstance"
-for each row. You need to specify at least one column for each query. If you
-specify more than one column, the value of all columns will be join together
-with the hyphen as separation character.
+Specifies the columns whose values will be used to create the "type-instance"
+for each row. If you specify more than one column, the value of all columns
+will be join together with the dashes I<("-")> as separation character.
The plugin itself does not check whether or not all built instances are
-different. It's your responsibility to assure that each is unique.
+different. It's your responsibility to assure that each is unique. This is
+especially true, if you do not specify B: B have to make
+sure that only one row is returned in this case.
-There must be at least one B option inside each B block.
+If neither B nor B is given, the type-instance
+will be empty.
=item B I [I ...]
@@ -955,97 +962,6 @@ Controls whether or not to recurse into subdirectories. Enabled by default.
=back
-=head2 Plugin C
-
-This plugin allows you to filter and rewrite value lists based on
-Perl-compatible regular expressions whose syntax and semantics are as close as
-possible to those of the Perl 5 language. See L for details.
-
-
-
- Host "^mail\d+$"
- Plugin "^tcpconns$"
- TypeInstance "^SYN_"
-
- Action NoWrite
-
-
-
- Plugin "^sensors$"
- PluginInstance "^Some Weird Sensor Chip Name Prefix"
-
- SubstitutePluginInstance "foo"
-
-
-
-The configuration consists of one or more C blocks, each of which
-specifies a regular expression identifying a set of value lists and how to
-handle successful matches. A value list keeps the values of a single data-set
-and is identified by the tuple (host, plugin, plugin instance, type, type
-instance). The plugin and type instances are optional components. If they are
-missing they are treated as empty strings. Within those blocks, the following
-options are recognized:
-
-=over 4
-
-=item B I
-
-=item B I
-
-=item B I
-
-=item B I
-
-=item B I
-
-Specifies the regular expression for each component of the identifier. If any
-of these options is missing it is interpreted as a pattern which matches any
-string. All five components of a value list have to match the appropriate
-regular expression to trigger the specified action.
-
-=item B I|I|I
-
-Specify how to handle successful matches:
-
-=over 4
-
-=item B
-
-Do not send the value list to any output (a.k.a. write) plugins.
-
-=item B
-
-Skip threshold checking for this value list.
-
-=item B
-
-Completely ignore this value list.
-
-=back
-
-Two or more actions may be combined by specifying multiple B options.
-
-=item B I
-
-=item B I
-
-=item B I
-
-=item B I
-
-=item B I
-
-Upon a successful match, the matching substring will be replaced by the
-specified I text. These options require that an appropriate regex
-has been specified before, e.Eg. B requires that the
-B option has been specified before.
-
-B: It is not recommended to modify the type unless you really know what
-you are doing. The type is used to identify the data-set definition of the
-dispatched values.
-
-=back
-
=head2 Plugin C
To get values from B collectd connects to B (127.0.0.1),
@@ -1581,6 +1497,61 @@ has been specified, the default is used as well.
=back
+=head2 Plugin C
+
+The I plugin uses the I library to send notifications to a
+configured email address.
+
+I is available from L.
+
+Available configuration options:
+
+=over 4
+
+=item B I
+
+Email address from which the emails should appear to come from.
+
+Default: C
+
+=item B I
+
+Configures the email address(es) to which the notifications should be mailed.
+May be repeated to send notifications to multiple addresses.
+
+At least one B must be present for the plugin to work correctly.
+
+=item B I
+
+Hostname of the SMTP server to connect to.
+
+Default: C
+
+=item B I
+
+TCP port to connect to.
+
+Default: C<25>
+
+=item B I
+
+Username for ASMTP authentication. Optional.
+
+=item B I
+
+Password for ASMTP authentication. Optional.
+
+=item B I
+
+Subject-template to use when sending emails. There must be exactly two
+string-placeholders in the subject, given in the standard I syntax,
+i.Ee. C<%s>. The first will be replaced with the severity, the second
+with the hostname.
+
+Default: C
+
+=back
+
=head2 Plugin C
=over 4
@@ -2390,7 +2361,7 @@ reduces IO-operations and thus lessens the load produced by updating the files.
The trade off is that the graphs kind of "drag behind" and that more memory is
used.
-=item B B
+=item B I
When collecting many statistics with collectd and the C plugin, you
will run serious performance problems. The B setting and the
@@ -2896,16 +2867,16 @@ only one such notification is generated until the value appears again.
=head1 FILTER CONFIGURATION
-TODO: Update this entire section once development is done.
-
Starting with collectd 4.6 there is a powerful filtering infrastructure
-implemented in the daemon. The concept has mostly been copied from I,
-the packet filter infrastructure for Linux. We'll use a similar terminology, so
-that users that are familiar with iptables feel right at home.
+implemented in the daemon. The concept has mostly been copied from
+I, the packet filter infrastructure for Linux. We'll use a similar
+terminology, so that users that are familiar with iptables feel right at home.
=head2 Terminology
-The most important terms are:
+The following are the terms used in the remainder of the filter configuration
+documentation. For an ASCII-art schema of the mechanism, see
+L<"General structure"> below.
=over 4
@@ -2914,15 +2885,18 @@ The most important terms are:
A I is a criteria to select specific values. Examples are, of course, the
name of the value or it's current value.
+Matches are implemented in plugins which you have to load prior to using the
+match. The name of such plugins starts with the "match_" prefix.
+
=item B
A I is some action that is to be performed with data. Such actions
could, for example, be to change part of the value's identifier or to ignore
-the value completely. Built-in functions are B and B, see below.
+the value completely.
-Some targets, for example the built-in B target, signal that processing
-of a value should be stopped. In that case processing of the current chain will
-be aborted.
+Some of these targets are built into the daemon, see L<"Built-in targets">
+below. Other targets are implemented in plugins which you have to load prior to
+using the target. The name of such plugins starts with the "target_" prefix.
=item B
@@ -2931,18 +2905,14 @@ I. The target actions will be performed for all values for which B
matches apply. If the rule does not have any matches associated with it, the
target action will be performed for all values.
-If any target returns the stop condition, the processing will stop right away.
-This means that any targets following the current one will not be called after
-the stop condition has been returned.
-
=item B
A I is a list of rules and possibly default targets. The rules are tried
in order and if one matches, the associated target will be called. If a value
is handled by a rule, it depends on the target whether or not any subsequent
-rules are considered or if traversal of the chain is aborted. After all rules
-have been checked and no target returned the stop condition, the default
-targets will be executed.
+rules are considered or if traversal of the chain is aborted, see
+L<"Flow control"> below. After all rules have been checked, the default targets
+will be executed.
=back
@@ -2979,12 +2949,46 @@ The following shows the resulting structure:
! Target !
+---------+
+=head2 Flow control
+
+There are four ways to control which way a value takes through the filter
+mechanism:
+
+=over 4
+
+=item B
+
+The built-in B target can be used to "call" another chain, i.Ee.
+process the value with another chain. When the called chain finishes, usually
+the next target or rule after the jump is executed.
+
+=item B
+
+The stop condition, signaled for example by the built-in target B, causes
+all processing of the value to be stopped immediately.
+
+=item B
+
+Causes processing in the current chain to be aborted, but processing of the
+value generally will continue. This means that if the chain was called via
+B, the next target or rule after the jump will be executed. If the chain
+was not called by another chain, control will be returned to the daemon and it
+may pass the value to another chain.
+
+=item B
+
+Most targets will signal the B condition, meaning that processing
+should continue normally. There is no special built-in target for this
+condition.
+
+=back
+
=head2 Synopsis
The configuration reflects this structure directly:
- PostCacheChain "main"
-
+ PostCacheChain "PostCache"
+
Plugin "^mysql$"
@@ -3047,7 +3051,7 @@ read-plugins to the write-plugins:
: dispatch values :
+ - - - - - - - - - +
-After the values are passed from the read-plugins to the dispatch functions,
+After the values are passed from the "read" plugins to the dispatch functions,
the pre-cache chain is run first. The values are added to the internal cache
afterwards. The post-cache chain is run after the values have been added to the
cache. So why is it such a huge deal if chains are run before or after the
@@ -3055,10 +3059,10 @@ values have been added to this cache?
Targets that change the identifier of a value list should be executed before
the values are added to the cache, so that the name in the cache matches the
-name that is used in the write-plugins. The C plugin, too, uses this
-cache to receive a list of all available values. If you change the identifier
-after the value list has been added to the cache, this may easily lead to
-confusion, but it's not forbidden of course.
+name that is used in the "write" plugins. The C plugin, too, uses
+this cache to receive a list of all available values. If you change the
+identifier after the value list has been added to the cache, this may easily
+lead to confusion, but it's not forbidden of course.
The cache is also used to convert counter values to rates. These rates are, for
example, used by the C match (see below). If you use the rate stored in
@@ -3132,11 +3136,11 @@ plugins to be loaded:
=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.
+Signals the "return" condition, see the L<"Flow control"> section above. 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.
@@ -3146,9 +3150,9 @@ Example:
=item B
-Signals the "stop" condition, causing processing of the value to be aborted
-immediately. This is similar to the B target of iptables, see
-L.
+Signals the "stop" condition, see the L<"Flow control"> section above. This
+causes 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.
@@ -3158,7 +3162,7 @@ Example:
=item B
-Sends the value to write plugins.
+Sends the value to "write" plugins.
Available options:
@@ -3182,11 +3186,11 @@ Example:
=item B
-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.
+Starts processing the rules of another chain, see L<"Flow control"> above. 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:
@@ -3483,22 +3487,20 @@ 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
+If you specify a B, 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!
+suggest to add the above snippet as default target to your "PostCache" chain.
=head2 Examples
Ignore all values, where the hostname does not contain a dot, i.Ee. can't
be an FQDN.
-
+
Host "^[^\.]*$"
@@ -3519,7 +3521,6 @@ L,
L,
L,
L,
-L,
L,
L,
L,