X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=2da6fe40b54ba3b4c3f8cfa71175b22dc2a095f4;hb=ff9e11ade5cfabf32c63fb19fc76cbbc4186bc5b;hp=a5af576239492a379ca88b40ac324bf5ed9d245a;hpb=e96afedbc67f8a508e37b73217c224aa5bd25f66;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index a5af5762..2da6fe40 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -38,7 +38,7 @@ i.e. a CPluginE...E> block. The syntax of this config file is similar to the config file of the famous I webserver. Each line contains either an option (a key and a list of one or more values) or a section-start or -end. Empty lines and everything -after a non-quoted hash-symbol (C<#>) is ignored. I are unquoted +after a non-quoted hash-symbol (C<#>) are ignored. I are unquoted strings, consisting only of alphanumeric characters and the underscore (C<_>) character. Keys are handled case insensitive by I itself and all plugins included with it. I can either be an I, a @@ -70,7 +70,7 @@ CB ...E> block. =item B I -Sets the base directory. This is the directory beneath all RRD-files are +Sets the base directory. This is the directory beneath which all RRD-files are created. Possibly more subdirectories are created. This is also the working directory for the daemon. @@ -83,7 +83,7 @@ I will be mostly useless. 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 +block I the 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. @@ -127,13 +127,13 @@ 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. +global B setting. If a plugin provides its own support for specifying +an interval, that setting will take precedence. =item B I -Specifies the the interval, in seconds, to call the flush callback if it's -defined in this plugin. By default, this is disabled +Specifies the interval, in seconds, to call the flush callback if it's +defined in this plugin. By default, this is disabled. =item B I @@ -159,12 +159,27 @@ plugins that don't provide any configuration, e.g. the I. When set to B, various statistics about the I daemon will be collected, with "collectd" as the I. Defaults to B. -The "write_queue" I reports the number of elements currently -queued and the number of elements dropped off the queue by the -B/B mechanism. +The following metrics are reported: -The "cache" I reports the number of elements in the value list -cache (the cache you can interact with using L). +=over 4 + +=item C + +The number of metrics currently in the write queue. You can limit the queue +length with the B and B options. + +=item C + +The number of metrics dropped due to a queue length limitation. +If this value is non-zero, your system can't handle all incoming metrics and +protects itself against overload by dropping metrics. + +=item C + +The number of elements in the metric cache (the cache you can interact with +using L). + +=back =item B I [I] @@ -193,13 +208,11 @@ 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" +matching C<*.conf> in any subdirectory of C. =back -If more than one files are included by a single B option, the files +If more than one file is 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 order in which the files are loaded. @@ -240,7 +253,7 @@ magic! (Assuming you're using the I or I plugin.) =item B I -Read plugin doubles interval between queries after each failed attempt +A read plugin doubles the interval between queries after each failed attempt to get data. This options limits the maximum value of the interval. The default value is @@ -2516,7 +2529,7 @@ a more detailed description see B below. =item B I|I -If no configuration if given, the B-plugin will collect data from +If no configuration if given, the B-plugin will collect data from all interfaces. This may not be practical, especially for loopback- and similar interfaces. Thus, you can use the B-option to pick the interfaces you're interested in. Sometimes, however, it's easier/preferred @@ -2525,6 +2538,34 @@ do that: By setting B to I the effect of B is inverted: All selected interfaces are ignored and all other interfaces are collected. +It is possible to use regular expressions to match interface names, if the +name is surrounded by I and collectd was compiled with support for +regexps. This is useful if there's a need to collect (or ignore) data +for a group of interfaces that are similarly named, without the need to +explicitly list all of them (especially useful if the list is dynamic). +Example: + + Interface "lo" + Interface "/^veth/" + Interface "/^tun[0-9]+/" + IgnoreSelected "true" + +This will ignore the loopback interface, all interfaces with names starting +with I and all interfaces with names starting with I followed by +at least one digit. + + +=item B I|I + +Interface name is not unique on Solaris (KSTAT), interface name is unique +only within a module/instance. Following tuple is considered unique: + (ks_module, ks_instance, ks_name) +If this option is set to true, interface name contains above three fields +separated by an underscore. For more info on KSTAT, visit +L + +This option is only available on Solaris. + =back =head2 Plugin C @@ -2565,9 +2606,13 @@ a notification is sent. =item B I I [I [I]] -Select the rules to count. If only I
and I are given, this plugin -will collect the counters of all rules which have a comment-match. The comment -is then used as type-instance. +=item B I
I [I [I]] + +Select the iptables/ip6tables filter rules to count packets and bytes from. + +If only I
and I are given, this plugin will collect the counters +of all rules which have a comment-match. The comment is then used as +type-instance. If I or I is given, only the rule with the matching comment or the Ith rule will be collected. Again, the comment (or the number) will be @@ -4453,6 +4498,18 @@ Sets the I to write to. Defaults to F +The C plugin collects per-peer ntpd data such as time offset and time +dispersion. + +For talking to B, it mimics what the B control program does on +wire - using B specific requests. This mode is deprecated with +newer B releases (4.2.7p230 and later). For the C plugin to work +correctly with them, the ntp daemon must be explicitly configured to +enable B (which is disabled by default). Refer to the I +manual page for details. + +Available configuration options for the C plugin: + =over 4 =item B I @@ -6241,9 +6298,9 @@ removed from the internal cache. =item B B|B -When enabled, create a C metric which reports the change since the last +When enabled, creates a C metric which reports the change since the last read. This option primarily exists for compatibility with the I -impelemtation by Etsy. +implementation by Etsy. =item B I @@ -7518,6 +7575,12 @@ authentication. Password required to load the private key in B. +=item B
I
+ +A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example: + + Header "X-Custom-Header: custom_value" + =item B B|B|B|B|B|B Define which SSL protocol version must be used. By default C will @@ -8891,6 +8954,8 @@ Available options: =item B I +=item B I I + Set the appropriate field to the given string. The strings for plugin instance and type instance may be empty, the strings for host and plugin may not be empty. It's currently not possible to set the type of a value this way.