X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=e6f771e524141c75db7b9f093c0219283d462d87;hb=4ebf1f93bbf273cb3833c333c101ee6b9aea6bc1;hp=dcf6c36d54861e2c1bd802291f63ccc47e39ebeb;hpb=78e4df368cd6fd548427d52ecd288c96e2029ce6;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index dcf6c36d..e6f771e5 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -555,6 +555,7 @@ B # GraphiteEscapeChar "_" # GraphiteSeparateInstances false # GraphiteAlwaysAppendDS false + # GraphitePreserveSeparator false # Receive values from an AMQP broker @@ -729,6 +730,12 @@ If set to 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. +=item B B|B + +If set to B (the default) the C<.> (dot) character is replaced with +I. Otherwise, if set to B, the C<.> (dot) character +is preserved, i.e. passed through. + =back =head2 Plugin C @@ -3315,6 +3322,28 @@ TCP-Port to connect to. Defaults to B<411>. =back +=head2 Plugin C + +The C uses mcelog to retrieve machine check exceptions, etc. + +By default the plugin connects to B<"/var/run/mcelog-client"> to check if the +mcelog server is running. When the server is running, the plugin will tail the +specified logfile to retrieve machine check exception information and send a +notification with the details from the logfile. The plugin will use the mcelog +client protocol to retrieve memory errors. + +=over 4 + +=item B I +Connect to mcelog client socket using the UNIX domain socket at I. +Defaults to B<"/var/run/mcelog-client">. + +=item B I + +mcelog file to parse. Defaults to B<"/var/log/mcelog">. + +=back + =head2 Plugin C The C collects information from Linux Software-RAID devices (md). @@ -4871,7 +4900,7 @@ so the values will not loop. =item B B|B The network plugin cannot only receive and send statistics, it can also create -statistics about itself. Collected data included the number of received and +statistics about itself. Collectd data included the number of received and sent octets and packets, the length of the receive queue and the number of values handled. When set to B, the I will make these statistics available. Defaults to B. @@ -7082,6 +7111,15 @@ user using (extended) regular expressions, as described in L. Type "counter" Instance "local_user" + + Regex "l=([0-9]*\\.[0-9]*)" + + Percentile 99 + Bucket 0 100 + + Type "latency" + Instance "foo" + @@ -7180,14 +7218,74 @@ Increase the internal counter by one. These B are the only ones that do not use the matched subexpression, but simply count the number of matched lines. Thus, you may use a regular expression without submatch in this case. +=item B + +Type to do calculations based on the distribution of values, primarily +calculating percentiles. This is primarily geared towards latency, but can be +used for other metrics as well. The range of values tracked with this setting +must be in the range (0–2^34) and can be fractional. Please note that neither +zero nor 2^34 are inclusive bounds, i.e. zero I be handled by a +distribution. + +This option must be used together with the B and/or B +options. + +B + + + Percentile 99 + Bucket 0 100 + + +=over 4 + +=item B I + +Calculate and dispatch the configured percentile, i.e. compute the value, so +that I of all matched values are smaller than or equal to the computed +latency. + +Metrics are reported with the I B (the value of the above option) +and the I C<[EInstanceE-]EPercentE>. + +This option may be repeated to calculate more than one percentile. + +=item B I I + +Export the number of values (a C) falling within the given range. Both, +I and I may be a fractional number, such as B<0.5>. +Each B option specifies an interval C<(I, +I]>, i.e. the range I the lower bound and I +the upper bound. I and I may be zero, meaning no +lower/upper bound. + +To export the entire (0–inf) range without overlap, use the upper bound of the +previous range as the lower bound of the following range. In other words, use +the following schema: + + Bucket 0 1 + Bucket 1 2 + Bucket 2 5 + Bucket 5 10 + Bucket 10 20 + Bucket 20 50 + Bucket 50 0 + +Metrics are reported with the I C and the I +CTypeE[-EInstanceE]-Elower_boundE_Eupper_boundE>. + +This option may be repeated to calculate more than one rate. + +=back + =back -As you'd expect the B types interpret the submatch as a floating point -number, using L. The B and B types interpret -the submatch as an unsigned integer using L. The B types -interpret the submatch as a signed integer using L. B -and B do not use the submatch at all and it may be omitted in this -case. +The B and B types interpret the submatch as a floating +point number, using L. The B and B types +interpret the submatch as an unsigned integer using L. The +B types interpret the submatch as a signed integer using +L. B and B do not use the submatch at all +and it may be omitted in this case. =item B I @@ -7442,7 +7540,7 @@ couple metrics: number of records, and database size on disk. =item B I -The hostname or ip which identifies the server. +The hostname or IP which identifies the server. Default: B<127.0.0.1> =item B I @@ -7456,61 +7554,60 @@ Default: B<1978> =head2 Plugin C The I reads CPU frequency and C-state residency on modern -Intel processors by using the new Model Specific Registers. +Intel processors by using I. =over 4 =item B I -Bitmask of the list of core C states supported by the processor. +Bit mask of the list of core C-states supported by the processor. This option should only be used if the automated detection fails. -Default value extracted from the cpu model and family. +Default value extracted from the CPU model and family. Currently supported C-states (by this plugin): 3, 6, 7 -Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states +B + + All states (3, 6 and 7): + (1<<3) + (1<<6) + (1<<7) = 392 =item B I -Bitmask of the list of pacages C states supported by the processor. -This option should only be used if the automated detection fails. -Default value extracted from the cpu model and family. +Bit mask of the list of packages C-states supported by the processor. This +option should only be used if the automated detection fails. Default value +extracted from the CPU model and family. Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10 -Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7 - -=item B I|I +B -Boolean enabling the collection of the I/O System-Management Interrupt -counter'. This option should only be used if the automated detection -fails or if you want to disable this feature. + States 2, 3, 6 and 7: + (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396 -=item B I|I +=item B I|I -Boolean enabling the collection of the temperature of each core. -This option should only be used if the automated detectionfails or -if you want to disable this feature. +Boolean enabling the collection of the I/O System-Management Interrupt counter. +This option should only be used if the automated detection fails or if you want +to disable this feature. =item B I|I -Boolean enabling the collection of the temperature of each package. -This option should only be used if the automated detectionfails or -if you want to disable this feature. +Boolean enabling the collection of the temperature of each core. This option +should only be used if the automated detection fails or if you want to disable +this feature. =item B I -Thermal Control Circuit Activation Temperature of the installed -CPU. This temperature is used when collecting the temperature of -cores or packages. This option should only be used if the automated -detection fails. Default value extracted from B +I of the installed CPU. This +temperature is used when collecting the temperature of cores or packages. This +option should only be used if the automated detection fails. Default value +extracted from B. =item B I -Bitmask of the list of elements to be thermally monitored. This option -should only be used if the automated detection fails or if you want to -disable some collections. The different bits of this bitmask accepted -by this plugin are: +Bit mask of the list of elements to be thermally monitored. This option should +only be used if the automated detection fails or if you want to disable some +collections. The different bits of this bit mask accepted by this plugin are: =over 4 @@ -7524,6 +7621,14 @@ by this plugin are: =back +=item B I|I + +Boolean enabling the use of logical core numbering for per core statistics. +When enabled, CnE> is used as plugin instance, where I is a +sequential number assigned by the kernel. Otherwise, CnE> is used +where I is the n-th core of the socket, causing name conflicts when there is +more than one socket. + =back =head2 Plugin C @@ -7890,6 +7995,12 @@ You can also specify combinations of the B and B fields. For example B means to concatenate the guest name and UUID (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">). +=item B B + +How many read instances you want to use for this plugin. The default is one, +and the sensible setting is a multiple of the B value. +If you are not sure, just use the default setting. + =back =head2 Plugin C @@ -8014,6 +8125,12 @@ If set to 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. +=item B B|B + +If set to B (the default) the C<.> (dot) character is replaced with +I. Otherwise, if set to B, the C<.> (dot) character +is preserved, i.e. passed through. + =item B B|B If set to B, detect and remove duplicate components in Graphite metric @@ -8054,6 +8171,8 @@ packets. Synopsis: + ResolveInterval 60 + ResolveJitter 60 Host "tsd-1.my.domain" Port "4242" @@ -8062,7 +8181,36 @@ Synopsis: The configuration consists of one or more EBEIE -blocks. Inside the B blocks, the following options are recognized: +blocks and global directives. + +Global directives are: + +=over 4 + +=item B I + +=item B I + +When I connects to a TSDB node, it will request the hostname from +DNS. This can become a problem if the TSDB node is unavailable or badly +configured because collectd will request DNS in order to reconnect for every +metric, which can flood your DNS. So you can cache the last value for +I seconds. +Defaults to the I of the I, e.g. 10Eseconds. + +You can also define a jitter, a random interval to wait in addition to +I. This prevents all your collectd servers to resolve the +hostname at the same time when the connection fails. +Defaults to the I of the I, e.g. 10Eseconds. + +B If the DNS resolution has already been successful when the socket +closes, the plugin will try to reconnect immediately with the cached +information. DNS is queried only when the socket is closed for a longer than +I + I seconds. + +=back + +Inside the B blocks, the following options are recognized: =over 4 @@ -8416,6 +8564,18 @@ 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 to 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. + +=item B B|B + +If set to B (the default) the C<.> (dot) character is replaced with +I. Otherwise, if set to B, the C<.> (dot) character +is preserved, i.e. passed through. + =item B B|B If set to B (the default), convert counter values to rates. If set to