X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=3ab264a3b2f6f34f4bddb1925b6bdb6fa927b30c;hb=9c6a92b8a30d63f6b476ab0bf0d166f3de41a7b1;hp=c21dac9748123922a9ace473905642a4bfe93b0c;hpb=d425636110c5fb146d1f6205e2749218f3c31076;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index c21dac97..3ab264a3 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -338,7 +338,7 @@ is enabled by default. =item B I Configure the name of the "pre-cache chain" and the "post-cache chain". Please -see L below on information on chains and how these +see L below on information on chains and how these setting change the daemon's behavior. =back @@ -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 @@ -1365,6 +1372,8 @@ Select I based on the name. Whether only matching I are collected or if they are ignored is controlled by the B option; see below. +See F for details. + =item B B|B Invert the selection: If set to true, all cgroups I the ones that @@ -2261,14 +2270,20 @@ values. Defaults to the global hostname setting. Select partitions based on the devicename. +See F for details. + =item B I Select partitions based on the mountpoint. +See F for details. + =item B I Select partitions based on the filesystem type. +See F for details. + =item B B|B Invert the selection: If set to true, all partitions B the ones that @@ -2330,6 +2345,8 @@ is interpreted as a regular expression. Examples: Disk "sdd" Disk "/hda[34]/" +See F for details. + =item B B|B Sets whether selected disks, i.Ee. the ones matches by any of the B @@ -2991,6 +3008,8 @@ than 1 sec. Select this interface. By default these interfaces will then be collected. For a more detailed description see B below. +See F for details. + =item B I|I If no configuration if given, the B-plugin will collect data from @@ -3052,6 +3071,8 @@ This option is only available on Solaris. Selects sensors to collect or to ignore, depending on B. +See F for details. + =item B I|I If no configuration if given, the B plugin will collect data from all @@ -3108,6 +3129,8 @@ comment or the number. Select this irq. By default these irqs will then be collected. For a more detailed description see B below. +See F for details. + =item B I|I If no configuration if given, the B-plugin will collect data from all @@ -3331,6 +3354,8 @@ 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. +See F for details. + =item B B|B Invert device selection: If set to B, all md devices B those @@ -4494,6 +4519,8 @@ regular and exact matching are case sensitive. If no volume was specified at all for either of the three options, that data will be collected for all available volumes. +See F for details. + =item B B|B =item B B|B @@ -4679,6 +4706,8 @@ Here are some examples to help you understand the above text more easily: Filter "ppp0" "u32-1:0" +See F for details. + =item B The behavior is the same as with all other similar plugins: If nothing is @@ -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. @@ -5201,6 +5230,8 @@ C). B is not used. As there can be multiple devices on the bus you can list multiple sensor (use multiple B elements). +See F for details. + =item B I|I If no configuration is given, the B plugin will collect data from all @@ -5525,10 +5556,10 @@ multiple hosts. =item B I Sets the interval in which to send ICMP echo packets to the configured hosts. -This is B the interval in which statistics are queries from the plugin but -the interval in which the hosts are "pinged". Therefore, the setting here -should be smaller than or equal to the global B setting. Fractional -times, such as "1.24" are allowed. +This is B the interval in which metrics are read from the plugin but the +interval in which the hosts are "pinged". Therefore, the setting here should be +smaller than or equal to the global B setting. Fractional times, such +as "1.24" are allowed. Default: B<1.0> @@ -5645,7 +5676,7 @@ L. Interval 300 Service "service_name" - Query backend # predefined + Query backends # predefined Query rt36_tickets @@ -6260,6 +6291,8 @@ Whether only matched values are selected or all matched values are ignored depends on the B. By default, only matched values are selected. If no value is configured at all, all values will be selected. +See F for details. + =item B B|B If set to B, inverts the selection made by B, i.Ee. all @@ -6613,14 +6646,20 @@ one (exclusive). When the C plugin uses a cache (by setting B, see below) it writes all values for a certain RRD-file if the oldest value is older than -(or equal to) the number of seconds specified. If some RRD-file is not updated +(or equal to) the number of seconds specified by B. +That check happens on new values arriwal. If some RRD-file is not updated anymore for some reason (the computer was shut down, the network is broken, -etc.) some values may still be in the cache. If B is set, then the -entire cache is searched for entries older than B seconds and -written to disk every I seconds. Since this is kind of expensive and -does nothing under normal circumstances, this value should not be too small. -900 seconds might be a good value, though setting this to 7200 seconds doesn't -normally do much harm either. +etc.) some values may still be in the cache. If B is set, then +every I seconds the entire cache is searched for entries older than +B + B seconds. The entries found are written to +disk. Since scanning the entire cache is kind of expensive and does nothing +under normal circumstances, this value should not be too small. 900 seconds +might be a good value, though setting this to 7200 seconds doesn't normally +do much harm either. + +Defaults to 10x B. +B must be larger than or equal to B, otherwise the +above default is used. =item B I @@ -6688,6 +6727,8 @@ on the B below. For example, the option "B I" will cause collectd to gather data for the voltage sensor I of the I on the isa bus at the address 0290. +See F for details. + =item B I|I If no configuration if given, the B-plugin will collect data from all @@ -6797,6 +6838,8 @@ is interpreted as a regular expression. Examples: Disk "sdd" Disk "/hda[34]/" +See F for details. + =item B B|B Sets whether selected disks, i.Ee. the ones matches by any of the B @@ -6896,6 +6939,8 @@ Calculate and dispatch various values out of I metrics received during an interval. If set to B, the default, these values aren't calculated / dispatched. +Please note what reported timer values less than 0.001 are ignored in all B reports. + =back =head2 Plugin C @@ -7082,6 +7127,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 +7234,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 @@ -7415,6 +7529,8 @@ Selects the name of the thermal device that you want to collect or ignore, depending on the value of the B option. This option may be used multiple times to specify a list of devices. +See F for details. + =item B I|I Invert the selection: If set to true, all devices B the ones that @@ -7442,7 +7558,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 +7572,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 +7639,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 @@ -8014,6 +8137,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 @@ -8148,6 +8277,41 @@ want to use authentication all three fields must be set. =back +=head2 Plugin C + +The I implements a tiny webserver that can be scraped +using I. + +B + +=over 4 + +=item B I + +Port the embedded webserver should listen on. Defaults to B<9103>. + +=item B I + +Time in seconds after which I considers a metric "stale" if it +hasn't seen any update for it. This value must match the setting in Prometheus. +It defaults to B<300> seconds (5 minutes), same as Prometheus. + +B + +I has a global setting, C, which controls after +which time a metric without updates is considered "stale". This setting +effectively puts an upper limit on the interval in which metrics are reported. + +When the I encounters a metric with an interval +exceeding this limit, it will inform you, the user, and provide the metric to +I B a timestamp. That causes I to consider the +metric "fresh" each time it is scraped, with the time of the scrape being +considered the time of the update. The result is that there appear more +datapoints in I than were actually created, but at least the metric +doesn't disappear periodically. + +=back + =head2 Plugin C This output plugin submits values to an HTTP server using POST requests and @@ -8381,6 +8545,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 @@ -9719,6 +9895,48 @@ be an FQDN. Target "write" +=head1 IGNORELISTS + +B are a generic framework to either ignore some metrics or report +specific metircs only. Plugins usually provide one or more options to specify +the items (mounts points, devices, ...) and the boolean option +C. + +=over 4 + +=item B option may be repeated to select multiple items. + +=item B B|B + +If set to B, matching metrics are I and all other metrics are +collected. If set to B, matching metrics are I and all other +metrics are ignored. + +=back + =head1 SEE ALSO L,