X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=c025f94928552961b2056e70029d2694a128343e;hb=d6021a800b12c89b5a78877af2c5b9abc1a8e609;hp=64ef7f2e9e49db053737dee5da9764bc1270797c;hpb=3e9d0babd83c359ffa114c0bc0f808cade99e3e8;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 64ef7f2e..c025f949 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -25,22 +25,32 @@ controls which plugins to load. These plugins ultimately define collectd's behavior. The syntax of this config file is similar to the config file of the famous -B. Each line contains either a key-value-pair or a -section-start or -end. Empty lines and everything after the hash-symbol `#' is -ignored. Values are either string, enclosed in double-quotes, -(floating-point-)numbers or a boolean expression, i.Ee. either B or -B. String containing of only alphanumeric characters and underscores do -not need to be quoted. Lines may be wrapped by using `\' as the last character -before the newline. This allows long lines to be split into multiple lines. -Quoted strings may be wrapped as well. However, those are treated special in -that whitespace at the beginning of the following lines will be ignored, which -allows for nicely indenting the wrapped lines. - -The configuration is read and processed in order, i.Ee. from top to -bottom. So the plugins are loaded in the order listed in this config file. It -is a good idea to load any logging plugins first in order to catch messages -from plugins during configuration. Also, the C option B occur -B the CPlugin ...E> block. +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 +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 +I (enclosed in double-quotes) a I or a I +expression. I consist of only alphanumeric characters and +underscores (C<_>) and do not need to be quoted. I are +enclosed in double quotes (C<">). You can use the backslash character (C<\>) +to include double quotes as part of the string. I can be specified in +decimal and floating point format (using a dot C<.> as decimal separator), +hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>). +I values are either B or B. + +Lines may be wrapped by using C<\> as the last character before the newline. +This allows long lines to be split into multiple lines. Quoted strings may be +wrapped as well. However, those are treated special in that whitespace at the +beginning of the following lines will be ignored, which allows for nicely +indenting the wrapped lines. + +The configuration is read and processed in order, i.e. from top to bottom. So +the plugins are loaded in the order listed in this config file. It is a good +idea to load any logging plugins first in order to catch messages from plugins +during configuration. Also, the C option B occur B +the appropriate CPlugin ...E> block. =head1 GLOBAL OPTIONS @@ -483,6 +493,7 @@ Synopsis: URL "http://localhost:8053/" + ParseTime false OpCodes true QTypes true @@ -509,35 +520,44 @@ 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 B|B + +When set to B, the time provided by BIND will be parsed and used to +dispatch the values. When set to B, the local time source is queried. + +This setting is set to B by default for backwards compatibility; setting +this to B is I to avoid problems with timezones and +localization. + +=item B B|B When enabled, statistics about the I<"OpCodes">, for example the number of C packets, are collected. Default: Enabled. -=item B I|I +=item B B|B When enabled, the number of I queries by query types (for example C, C, C) is collected. Default: Enabled. -=item B I|I +=item B B|B Collect global server statistics, such as requests received over IPv4 and IPv6, successful queries, and failed updates. Default: Enabled. -=item B I|I +=item B B|B Collect zone maintenance statistics, mostly information about notifications (zone updates) and zone transfers. Default: Enabled. -=item B I|I +=item B B|B Collect resolver statistics, i.Ee. statistics about outgoing requests (e.Eg. queries over IPv4, lame servers). Since the global resolver @@ -566,21 +586,21 @@ configured, no detailed view statistics will be collected. =over 4 -=item B I|I +=item B B|B If enabled, the number of I queries by query type (e.Eg. C, C) is collected. Default: Enabled. -=item B I|I +=item B B|B Collect resolver statistics, i.Ee. statistics about outgoing requests (e.Eg. queries over IPv4, lame servers). Default: Enabled. -=item B I|I +=item B B|B 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 @@ -1262,6 +1282,41 @@ at most B<16384> to prevent typos and dumb mistakes. =back +=head2 Plugin C + +The I collects information about network interface cards (NICs) +by talking directly with the underlying kernel driver using L. + +B + + + Interface "eth0" + Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload" + Map "multicast" "if_multicast" + + +B + +=over 4 + +=item B I + +Collect statistical information about interface I. + +=item B I I [I] + +By default, the plugin will submit values as type C and I set to I, the name of the metric as reported by the driver. If +an appropriate B option exists, the given I and, optionally, +I will be used. + +=item B B|B + +When set to B, only metrics that can be mapped to to a I will be +collected, all other metrics will be ignored. Defaults to B. + +=back + =head2 Plugin C Please make sure to read L before using this plugin. It @@ -1812,6 +1867,31 @@ TCP-Port to connect to. Defaults to B<411>. =back +=head2 Plugin C + +The C collects information from Linux Software-RAID devices (md). + +All reported values are of the type C. Reported type instances are +I, I (present but not operational), I (hot stand-by) and +I (physically absent) disks. + +=over 4 + +=item B I + +Select md devices based on device name. The I is the basename of +the device, i.e. the name of the block device without the leading C. +See B for more details. + +=item B B|B + +Invert device selection: If set to B, all md devices B those +listed using B are collected. If B (the default), only those +listed are collected. If no configuration is given, the B plugin will +collect data from all md devices. + +=back + =head2 Plugin C The C connects to a memcached server, queries one or more @@ -2654,10 +2734,18 @@ The default IPv6 multicast group is C. The default IPv4 multicast group is C<239.192.74.66>. The default I port is B<25826>. Both, B and B can be used as single option or as block. When -used as block, given options are valid for this socket only. For example: +used as block, given options are valid for this socket only. The following +example will export the metrics twice: Once to an "internal" server (without +encryption and signing) and one to an external server (with cryptographic +signature): + # Export to an internal server + # (demonstrates usage without additional options) Server "collectd.internal.tld" + + # Export to an external server + # (demonstrates usage with signature options) SecurityLevel "sign" Username "myhostname" @@ -2786,7 +2874,18 @@ operating systems. =item B I<1024-65535> Set the maximum size for datagrams received over the network. Packets larger -than this will be truncated. Defaults to 1452Ebytes. +than this will be truncated. Defaults to 1452Ebytes, which is the maximum +payload size that can be transmitted in one Ethernet frame using IPv6E/ +UDP. + +On the server side, this limit should be set to the largest value used on +I client. Likewise, the value on the client must not be larger than the +value on the server, or data will be lost. + +B Versions prior to I4.8> used a fixed sized +buffer of 1024Ebytes. Versions I<4.8>, I<4.9> and I<4.10> used a default +value of 1024Ebytes to avoid problems when sending data to an older +server. =item B I @@ -4149,6 +4248,11 @@ L. =over 4 +=item B I + +Read the I configuration from I. When unset (recommended), +the library's default will be used. + =item B I Selects the name of the sensor which you want to collect or ignore, depending @@ -4206,6 +4310,15 @@ syslog-daemon. Please note that B is only available if collectd has been compiled with debugging support. +=item B B|B|B + +Controls which notifications should be sent to syslog. The default behaviour is +not to send any. Less severe notifications always imply logging more severe +notifications: Setting this to B means all notifications will be sent to +syslog, setting this to B will send B and B +notifications but will dismiss B notifications. Setting this option to +B will only send failures to syslog. + =back =head2 Plugin C @@ -4758,8 +4871,11 @@ iptables to feed data for the guest IPs into the iptables plugin. =head2 Plugin C -The C plugin writes data to I, the storage layer of -I. +The C plugin writes data to I, an open-source metrics +storage and graphing project. The plugin connects to I, the data layer +of I, and sends data via the "line based" protocol (per default using +portE2003). The data will be sent in blocks of at most 1428 bytes to +minimize the number of network packets. Synopsis: @@ -4800,8 +4916,64 @@ underscore (C<_>). =item B B|B -If set to B, convert counter values to rates. If set to B (the -default) counter values are stored as is, i.Ee. as an increasing integer +If set to B (the default), convert counter values to rates. If set to +B counter values are stored as is, i.Ee. as an increasing integer +number. + +=item B B|B + +If set to B, the plugin instance and type instance will be in their own +path component, for example C. If set to B (the +default), the plugin and plugin instance (and likewise the type and type +instance) are put into one component, for example C. + +=item B B|B + +If set the B, append the name of the I (DS) to the "metric" +identifier. If set to B (the default), this is only done when there is +more than one DS. + +=back + +=head2 Plugin C + +The I will send values to I, a schema-less +NoSQL database. + +B + + + + Host "localhost" + Port "27017" + Timeout 1000 + StoreRates true + + + +The plugin can send values to multiple instances of I by specifying +one B block for each instance. Within the B blocks, the following +options are available: + +=over 4 + +=item B I
+ +Hostname or address to connect to. Defaults to C. + +=item B I + +Service name or port number to connect to. Defaults to C<27017>. + +=item B I + +Set the timeout for each operation on I to I milliseconds. +Setting this option to zero means no timeout, which is the default. + +=item B B|B + +If set to B (the default), convert counter values to rates. If set to +B counter values are stored as is, i.e. as an increasing integer number. =back @@ -4870,6 +5042,170 @@ number. =back +=head1 THRESHOLD CONFIGURATION + +Starting with version C<4.3.0> collectd has support for B. By that +we mean that the values are not only stored or sent somewhere, but that they +are judged and, if a problem is recognized, acted upon. The only action +collectd takes itself is to generate and dispatch a "notification". Plugins can +register to receive notifications and perform appropriate further actions. + +Since systems and what you expect them to do differ a lot, you can configure +B for your values freely. This gives you a lot of flexibility but +also a lot of responsibility. + +Every time a value is out of range a notification is dispatched. This means +that the idle percentage of your CPU needs to be less then the configured +threshold only once for a notification to be generated. There's no such thing +as a moving average or similar - at least not now. + +Also, all values that match a threshold are considered to be relevant or +"interesting". As a consequence collectd will issue a notification if they are +not received for B iterations. The B configuration option is +explained in section L<"GLOBAL OPTIONS">. If, for example, B is set to +"2" (the default) and some hosts sends it's CPU statistics to the server every +60 seconds, a notification will be dispatched after about 120 seconds. It may +take a little longer because the timeout is checked only once each B +on the server. + +When a value comes within range again or is received after it was missing, an +"OKAY-notification" is dispatched. + +Here is a configuration example to get you started. Read below for more +information. + + + + WarningMin 0.00 + WarningMax 1000.00 + FailureMin 0.00 + FailureMax 1200.00 + Invert false + Instance "bar" + + + + Instance "eth0" + + FailureMax 10000000 + DataSource "rx" + + + + + + Instance "idle" + FailureMin 10 + + + + + Instance "cached" + WarningMin 100000000 + + + + + +There are basically two types of configuration statements: The C, +C, and C blocks select the value for which a threshold should be +configured. The C and C blocks may be specified further using the +C option. You can combine the block by nesting the blocks, though +they must be nested in the above order, i.Ee. C may contain either +C and C blocks, C may only contain C blocks and +C may not contain other blocks. If multiple blocks apply to the same +value the most specific block is used. + +The other statements specify the threshold to configure. They B be +included in a C block. Currently the following statements are recognized: + +=over 4 + +=item B I + +=item B I + +Sets the upper bound of acceptable values. If unset defaults to positive +infinity. If a value is greater than B a B notification +will be created. If the value is greater than B but less than (or +equal to) B a B notification will be created. + +=item B I + +=item B I + +Sets the lower bound of acceptable values. If unset defaults to negative +infinity. If a value is less than B a B notification will +be created. If the value is less than B but greater than (or equal +to) B a B notification will be created. + +=item B I + +Some data sets have more than one "data source". Interesting examples are the +C data set, which has received (C) and sent (C) bytes and +the C data set, which holds C and C operations. The +system load data set, C, even has three data sources: C, +C, and C. + +Normally, all data sources are checked against a configured threshold. If this +is undesirable, or if you want to specify different limits for each data +source, you can use the B option to have a threshold apply only to +one data source. + +=item B B|B + +If set to B the range of acceptable values is inverted, i.Ee. +values between B and B (B and +B) are not okay. Defaults to B. + +=item B B|B + +Sets how often notifications are generated. If set to B one notification +will be generated for each value that is out of the acceptable range. If set to +B (the default) then a notification is only generated if a value is out +of range but the previous value was okay. + +This applies to missing values, too: If set to B a notification about a +missing value is generated once every B seconds. If set to B +only one such notification is generated until the value appears again. + +=item B B|B + +If set to B, the minimum and maximum values given are interpreted as +percentage value, relative to the other data sources. This is helpful for +example for the "df" type, where you may want to issue a warning when less than +5E% of the total space is available. Defaults to B. + +=item B I + +Delay creating the notification until the threshold has been passed I +times. When a notification has been generated, or when a subsequent value is +inside the threshold, the counter is reset. If, for example, a value is +collected once every 10Eseconds and B is set to 3, a notification +will be dispatched at most once every 30Eseconds. + +This is useful when short bursts are not a problem. If, for example, 100% CPU +usage for up to a minute is normal (and data is collected every +10Eseconds), you could set B to B<6> to account for this. + +=item B I + +When set to non-zero, a hysteresis value is applied when checking minimum and +maximum bounds. This is useful for values that increase slowly and fluctuate a +bit while doing so. When these values come close to the threshold, they may +"flap", i.e. switch between failure / warning case and okay case repeatedly. + +If, for example, the threshold is configures as + + WarningMax 100.0 + Hysteresis 1.0 + +then a I notification is created when the value exceeds I<101> and the +corresponding I notification is only created once the value falls below +I<99>, thus avoiding the "flapping". + +=back + =head1 FILTER CONFIGURATION Starting with collectd 4.6 there is a powerful filtering infrastructure @@ -5495,7 +5831,7 @@ convert counter values to rates. Please note that these placeholders are B! -=item B B<"FATAL">|B<"WARNING">|B<"OKAY"> +=item B B<"FAILURE">|B<"WARNING">|B<"OKAY"> Sets the severity of the message. If omitted, the severity B<"WARNING"> is used.