X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=48b75bc82f9cfa6a32e263c950dc108bbd67c915;hb=04b395325b152a5ddf424d1a750f455a2f8229fb;hp=c975b2c255e8367fb9dcc01195af3981b7fe8d1f;hpb=a16e967161314d4b2047e36ba0af0d7efa616919;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index c975b2c2..48b75bc8 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -279,6 +279,32 @@ available. This is done with the C configuration option: inet localhost port 8053; }; +The configuration follows the grouping that can be seen when looking at the +data with an XSLT compatible viewer, such as a modern web browser. It's +probably a good idea to make yourself familiar with the provided values, so you +can understand what the collected statistics actually mean. + +Synopsis: + + + URL "http://localhost:8053/" + OpCodes true + QTypes true + + ServerStats true + ZoneMaintStats true + ResolverStats false + MemoryStats true + + + QTypes true + ResolverStats true + CacheRRSets true + + Zone "127.in-addr.arpa/IN" + + + The bind plugin accepts the following configuration options: =over 4 @@ -288,34 +314,98 @@ The bind plugin accepts the following configuration options: URL from which to retrieve the XML data. If not specified, C will be used. -=item B I|I - =item B I|I -=item B I|I +When enabled, statistics about the I<"OpCodes">, for example the number of +C packets, are collected. + +Default: Enabled. + +=item B I|I + +When enabled, the number of I queries by query types (for example +C, C, C) is collected. + +Default: Enabled. + +=item B I|I + +Collect global server statistics, such as requests received over IPv4 and IPv6, +successful queries, and failed updates. + +Default: Enabled. + +=item B I|I + +Collect zone maintenance statistics, mostly information about notifications +(zone updates) and zone transfers. + +Default: Enabled. + +=item B I|I + +Collect resolver statistics, i.Ee. statistics about outgoing requests +(e.Eg. queries over IPv4, lame servers). Since the global resolver +counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by +default. Use the B option within a B block +instead for the same functionality. + +Default: Disabled. + +=item B + +Collect global memory statistics. + +Default: Enabled. + +=item B I + +Collect statistics about a specific I<"view">. BIND can behave different, +mostly depending on the source IP-address of the request. These different +configurations are called "views". If you don't use this feature, you most +likely are only interested in the C<_default> view. + +Within a EBEIE block, you can specify which +information you want to collect about a view. If no B block is +configured, no detailed view statistics will be collected. + +=over 4 + +=item B I|I + +If enabled, the number of I queries by query type (e.Eg. C, +C) is collected. -=item B I|I +Default: Enabled. -=item B I|I +=item B I|I -=item B I|I +Collect resolver statistics, i.Ee. statistics about outgoing requests +(e.Eg. queries over IPv4, lame servers). -=item B I|I +Default: Enabled. -=item B I|I +=item B I|I -=item B I|I +If enabled, the number of entries (I<"RR sets">) in the view's cache by query +type is collected. Negative entries (queries which resulted in an error, for +example names that do not exist) are reported with a leading exclamation mark, +e.Eg. "!A". -=item B I|I +Default: Enabled. -=item B I|I +=item B I -=item B I|I +When given, collect detailed information about the given zone in the view. The +information collected if very similar to the global B information +(see above). -=item B I|I +You can repeat this option to collect detailed information about multiple +zones. -Enables or disables collection of specific counters. -TODO: Options must be described in detail! +By default no detailed zone information is collected. + +=back =back @@ -364,12 +454,62 @@ finance page and dispatch the value to collectd. Regex "]*> *([0-9]*\\.[0-9]+) *" DSType "GaugeAverage" + # Note: `stock_value' is not a standard type. Type "stock_value" Instance "AMD" +In the B block, there may be one or more B blocks, each defining +a web page and one or more "matches" to be performed on the returned data. The +string argument to the B block is used as plugin instance. + +The following options are valid within B blocks: + +=over 4 + +=item B I + +URL of the web site to retrieve. Since a regular expression will be used to +extract information from this data, non-binary data is a big plus here ;) + +=item B I + +Username to use if authorization is required to read the page. + +=item B I + +Password to use if authorization is required to read the page. + +=item B B|B + +Enable or disable peer SSL certificate verification. See +L for details. Enabled by default. + +=item B B|B + +Enable or disable peer host name verification. If enabled, the plugin checks if +the C or a C field of the SSL certificate +matches the host name provided by the B option. If this identity check +fails, the connection is aborted. Obviously, only works when connecting to a +SSL enabled server. Enabled by default. + +=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 bundled with C +and are checked by default depends on the distribution you use. + +=item BMatchE> + +One or more B blocks that define how to match information in the data +returned by C. The C plugin uses the same infrastructure that's +used by the C plugin, so please see the documentation of the C +plugin below on how matches are defined. + +=back + =head2 Plugin C This plugin uses the B library (L) to @@ -389,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" @@ -513,20 +653,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 joined together with dashes I<("-")> as separation characters. 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 ...] @@ -815,97 +959,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), @@ -1030,6 +1083,65 @@ and all other interrupts are collected. =back +=head2 Plugin C + +Synopsis: + + + JVMArg "-verbose:jni" + JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java" + LoadPlugin "org.collectd.java.Foobar" + + # To be parsed by the plugin + + + +Available config options: + +=over 4 + +=item B I + +Argument that is to be passed to the I (JVM). This works +exactly the way the arguments to the I binary on the command line work. +Execute C--help> for details. + +=item B I + +Instantiates a new I object. The following methods of this class are +used when available: + +=over 4 + +=item * + +public int B (org.collectd.api.OConfigItem ci) + +=item * + +public int B () + +=item * + +public int B () + +=item * + +public int B (org.collectd.protocol.ValueList vl) + +=item * + +public int B () + +=back + +=item B I + +The entrie block is passed to the Java plugin as an +I object. + +=back + =head2 Plugin C This plugin allows CPU, disk and network load to be collected for virtualized @@ -1441,6 +1553,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 @@ -2250,7 +2417,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 @@ -2328,9 +2495,109 @@ debugging support. =back +=head2 Plugin C + +The C
provides generic means to parse tabular data and dispatch +user specified values. Values are selected based on column numbers. For +example, this plugin may be used to get values from the Linux L +filesystem or CSV (comma separated values) files. + + +
+ Instance "slabinfo" + Separator " " + + Type gauge + InstancePrefix "active_objs" + InstancesFrom 0 + ValuesFrom 1 + + + Type gauge + InstancePrefix "objperslab" + InstancesFrom 0 + ValuesFrom 4 + +
+ + +The configuration consists of one or more B blocks, each of which +configures one file to parse. Within each B
block, there are one or +more B blocks, which configure which data to select and how to +interpret it. + +The following options are available inside a B
block: + +=over 4 + +=item B I + +If specified, I is used as the plugin instance. So, in the above +example, the plugin name C would be used. If omitted, the +filename of the table is used instead, with all special characters replaced +with an underscore (C<_>). + +=item B I + +Any character of I is interpreted as a delimiter between the different +columns of the table. A sequence of two or more contiguous delimiters in the +table is considered to be a single delimiter, i.Ee. there cannot be any +empty columns. The plugin uses the L function to parse the lines +of a table - see its documentation for more details. This option is mandatory. + +A horizontal tab, newline and carriage return may be specified by C<\\t>, +C<\\n> and C<\\r> respectively. Please note that the double backslashes are +required because of collectd's config parsing. + +=back + +The following options are available inside a B block: + +=over 4 + +=item B I + +Sets the type used to dispatch the values to the daemon. Detailed information +about types and their configuration can be found in L. This +option is mandatory. + +=item B I + +If specified, prepend I to the type instance. If omitted, only the +B option is considered for the type instance. + +=item B I [I ...] + +If specified, the content of the given columns (identified by the column +number starting at zero) will be used to create the type instance for each +row. Multiple values (and the instance prefix) will be joined together with +dashes (I<->) as separation character. If omitted, only the B +option is considered for the type instance. + +The plugin itself does not check whether or not all built instances are +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 the table only contains one row. + +If neither B nor B is given, the type instance +will be empty. + +=item B I [I ...] + +Specifies the columns (identified by the column numbers starting at zero) +whose content is used as the actual data for the data sets that are dispatched +to the daemon. How many such columns you need is determined by the B +setting above. If you specify too many or not enough columns, the plugin will +complain about that and no data will be submitted to the daemon. The plugin +uses L and L to parse counter and gauge values +respectively, so anything supported by those functions is supported by the +plugin as well. This option is mandatory. + +=back + =head2 Plugin C -The C plugins follows logfiles, just like L does, parses +The C follows logfiles, just like L does, parses each line and dispatches found values. What is matched can be configured by the user using (extended) regular expressions, as described in L. @@ -2756,16 +3023,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 @@ -2774,15 +3041,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 @@ -2791,18 +3061,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 @@ -2839,12 +3105,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$" @@ -2907,7 +3207,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 @@ -2915,10 +3215,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 @@ -2992,11 +3292,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. @@ -3006,9 +3306,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. @@ -3018,7 +3318,7 @@ Example: =item B -Sends the value to write plugins. +Sends the value to "write" plugins. Available options: @@ -3042,11 +3342,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: @@ -3101,6 +3401,50 @@ Example: Plugin "^foobar$" +=item B + +Matches values that have a time which differs from the time on the server. + +This match is mainly intended for servers that receive values over the +C plugin and write them to disk using the C plugin. RRDtool +is very sensitive to the timestamp used when updating the RRD files. In +particular, the time must be ever increasing. If a misbehaving client sends one +packet with a timestamp far in the future, all further packets with a correct +time will be ignored because of that one packet. What's worse, such corrupted +RRD files are hard to fix. + +This match lets one match all values B a specified time range +(relative to the server's time), so you can use the B target (see below) +to ignore the value, for example. + +Available options: + +=over 4 + +=item B I + +Matches all values that are I of the server's time by I or more +seconds. Set to zero for no limit. Either B or B must be +non-zero. + +=item B I + +Matches all values that are I of the server's time by I or +more seconds. Set to zero for no limit. Either B or B must be +non-zero. + +=back + +Example: + + + Future 300 + Past 3600 + + +This example matches all values that are five minutes or more ahead of the +server or one hour (or more) lagging behind. + =item B Matches the actual value of data sources against given minimumE/ maximum @@ -3299,22 +3643,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 "^[^\.]*$" @@ -3335,7 +3677,6 @@ L, L, L, L, -L, L, L, L,