X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=6c39f71072bf4d9fc8d451b78c1cdabb26c1ab19;hb=7d71adcde084aef18f54dddb253c6a2d039b418d;hp=1c0f4f07055942703f1e00e007db315f6ecadc76;hpb=483e801902bca3c779793224eddf3bb2749d7288;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 1c0f4f07..6c39f710 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 @@ -1933,11 +2013,11 @@ Configures the base register to read from the device. If the option B has been set to B or B, this and the next register will be read (the register number is increased by one). -=item B B|B|B +=item B B|B|B|B|B -Specifies what kind of data is returned by the device. If the type is B -or B, two 16Ebit registers will be read and the data is combined -into one value. Defaults to B. +Specifies what kind of data is returned by the device. If the type is B, +B or B, two 16Ebit registers will be read and the data is +combined into one value. Defaults to B. =item B I @@ -4168,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 @@ -4196,19 +4281,19 @@ L. Please see there for details. =head2 Plugin C The I collects information about used and available swap space. On -I, the following options are available: +I and I, the following options are available: =over 4 =item B B|B -Configures how to report physical swap devices. If set to B is used (the +Configures how to report physical swap devices. If set to B (the default), the summary over all swap devices is reported only, i.e. the globally used and available space over all devices. If B is configured, the used and available space of each device will be reported separately. -This option is only available if the I can use the L -mechanism under I. +This option is only available if the I can read C +(under Linux) or use the L mechanism (under I). =back @@ -4225,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 @@ -4681,7 +4775,33 @@ Take the UUID from the given file (default I). =head2 Plugin C -The Varnish plugin collects information about Varnish, an HTTP accelerator. +The I collects information about Varnish, an HTTP accelerator. + +Synopsis: + + + + CollectCache true + CollectConnections true + CollectBackend true + CollectSHM true + CollectESI false + CollectFetch false + CollectHCB false + CollectSMA false + CollectSMS false + CollectSM false + CollectTotals false + CollectWorkers false + + + +The configuration consists of one or more EBEIE +blocks. I is the parameter passed to "varnishd -n". If left empty, it +will collectd statistics from the default "varnishd" instance (this should work +fine in most cases). + +Inside each EBE blocks, the following options are recognized: =over 4 @@ -4775,6 +4895,115 @@ traffic (e.Eg. due to headers and retransmission). If you want to collect on-wire traffic you could, for example, use the logging facilities of iptables to feed data for the guest IPs into the iptables plugin. +=head2 Plugin C + +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: + + + + Host "localhost" + Port "2003" + Prefix "collectd" + + + +=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<2003>. + +=item B I + +When set, I is added in front of the host name. Dots and whitespace are +I escaped in this string (see B below). + +=item B I + +When set, I is appended to the host name. Dots and whitespace are +I escaped in this string (see B below). + +=item B I + +I uses the dot (C<.>) as escape character and doesn't allow whitespace +in the identifier. The B option determines which character +dots, whitespace and control characters are replaced with. Defaults to +underscore (C<_>). + +=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.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 + =head2 Plugin C This output plugin submits values to an http server by POST them using the @@ -5628,7 +5857,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.