X-Git-Url: https://git.octo.it/?p=collectd.git;a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=881ae2017d0b63b502474a8a21898f64696e7481;hp=f88430a05d5a6d78555dc10cc36a2c3d7bc85a1d;hb=fbaf81a04c23d51947d94a5c7d9142290dff07bc;hpb=8a2be9037587c1b80a00ddb1d7d396d1d48ec37d diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index f88430a0..881ae201 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 @@ -1114,6 +1121,13 @@ When set to B, the battery plugin will report three values: B and "remaining capacity") and B (difference between "design capacity" and "last full capacity"). +=item B B|B + +When set to B, the battery plugin will only read statistics +related to battery performance as exposed by StateFS at +/run/state. StateFS is used in Mer-based Sailfish OS, for +example. + =back =head2 Plugin C @@ -2379,6 +2393,67 @@ Enabled by default, collects unknown (and thus presented as numeric only) query =back +=head2 Plugin C + +The I collects information about DPDK interfaces using the +extended NIC stats API in DPDK. + +B + + + Coremask "0x4" + MemoryChannels "4" + ProcessType "secondary" + FilePrefix "rte" + EnabledPortMask 0xffff + PortName "interface1" + PortName "interface2" + + +B + +=over 4 + +=item B I + +A string containing an hexadecimal bit mask of the cores to run on. Note that +core numbering can change between platforms and should be determined beforehand. + +=item B I + +A string containing a number of memory channels per processor socket. + +=item B I + +A string containing the type of DPDK process instance. + +=item B I + +The prefix text used for hugepage filenames. The filename will be set to +/var/run/._config where prefix is what is passed in by the user. + +=item B I + +A string containing amount of Memory to allocate from hugepages on specific +sockets in MB + +=item B I + +A hexidecimal bit mask of the DPDK ports which should be enabled. A mask +of 0x0 means that all ports will be disabled. A bitmask of all Fs means +that all ports will be enabled. This is an optional argument - default +is all ports enabled. + +=item B I + +A string containing an optional name for the enabled DPDK ports. Each PortName +option should contain only one port name; specify as many PortName options as +desired. Default naming convention will be used if PortName is blank. If there +are less PortName options than there are enabled ports, the default naming +convention will be used for the additional ports. + +=back + =head2 Plugin C =over 4 @@ -2829,6 +2904,101 @@ TCP-Port to connect to. Defaults to B<7634>. =back +=head2 Plugin C + +To collect B information, collectd reads directories +"/sys/devices/system/node/*/hugepages" and +"/sys/kernel/mm/hugepages". +Reading of these directories can be disabled by the following +options (default is enabled). + +=over 4 + +=item B B|B + +If enabled, information will be collected from the hugepage +counters in "/sys/devices/system/node/*/hugepages". +This is used to check the per-node hugepage statistics on +a NUMA system. + +=item B B|B + +If enabled, information will be collected from the hugepage +counters in "/sys/kernel/mm/hugepages". +This can be used on both NUMA and non-NUMA systems to check +the overall hugepage statistics. + +=item B B|B + +Whether to report hugepages metrics in number of pages. +Defaults to B. + +=item B B|B + +Whether to report hugepages metrics in bytes. +Defaults to B. + +=item B B|B + +Whether to report hugepages metrics as percentage. +Defaults to B. + +=back + +=head2 Plugin C + +The I plugin collects information provided by monitoring features of +Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring +Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide +information about utilization of shared resources. CMT monitors last level cache +occupancy (LLC). MBM supports two types of events reporting local and remote +memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of +accessing memory associated with the local socket. Remote memory bandwidth (MBR) +reports the bandwidth of accessing the remote socket. Also this technology +allows to monitor instructions per clock (IPC). +Monitor events are hardware dependant. Monitoring capabilities are detected on +plugin initialization and only supported events are monitored. + +B + + + Cores "0-2" "3,4,6" "8-10,15" + + +B + +=over 4 + +=item B I + +The interval within which to retrieve statistics on monitored events in seconds. +For milliseconds divide the time by 1000 for example if the desired interval +is 50ms, set interval to 0.05. Due to limited capacity of counters it is not +recommended to set interval higher than 1 sec. + +=item B I + +All events are reported on a per core basis. Monitoring of the events can be +configured for group of cores (aggregated statistics). This field defines groups +of cores on which to monitor supported events. The field is represented as list +of strings with core group values. Each string represents a list of cores in a +group. Allowed formats are: + 0,1,2,3 + 0-10,20-18 + 1,3,5-8,10,0x10-12 + +If an empty string is provided as value for this field default cores +configuration is applied - a separate group is created for each core. + +=back + +B By default global interval is used to retrieve statistics on monitored +events. To configure a plugin specific interval use B option of the +intel_rdt block. For milliseconds divide the time by 1000 for +example if the desired interval is 50ms, set interval to 0.05. +Due to limited capacity of counters it is not recommended to set interval higher +than 1 sec. + =head2 Plugin C =over 4 @@ -3250,11 +3420,12 @@ interpreted. For a description of match blocks, please see L<"Plugin tail">. The B connects to a memcached server and queries statistics about cache utilization, memory and bandwidth used. -L +L - Host "memcache.example.com" + #Host "memcache.example.com" + Address "127.0.0.1" Port 11211 @@ -3267,16 +3438,25 @@ following options are allowed: =item B I -Hostname to connect to. Defaults to B<127.0.0.1>. +Sets the B field of dispatched values. Defaults to the global hostname +setting. +For backwards compatibility, values are also dispatched with the global +hostname when B is set to B<127.0.0.1> or B and B
is +not set. + +=item B
I
+ +Hostname or IP to connect to. For backwards compatibility, defaults to the +value of B or B<127.0.0.1> if B is unset. =item B I -TCP-Port to connect to. Defaults to B<11211>. +TCP port to connect to. Defaults to B<11211>. =item B I Connect to I using the UNIX domain socket at I. If this -setting is given, the B and B settings are ignored. +setting is given, the B
and B settings are ignored. =back @@ -5723,7 +5903,7 @@ values are made available through those parameters: =item B<$1> -The timestamp of the queried value as a floating point number. +The timestamp of the queried value as an RFC 3339-formatted local time. =item B<$2> @@ -6939,6 +7119,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" + @@ -7001,6 +7190,13 @@ Use the greatest number only. Use the last number found. +=item B + +Use the last number found. The number is not reset at the end of an interval. +It is continously reported until another number is matched. This is intended +for cases in which only state changes are reported, for example a thermometer +that only reports the temperature when it changes. + =item B =item B @@ -7030,14 +7226,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 -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. +=back + +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 @@ -7294,7 +7550,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 @@ -7308,61 +7564,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 @@ -7376,6 +7631,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 @@ -7657,6 +7920,49 @@ Example: Ignore all I devices on any domain, but other block devices (eg. I) will be collected. +=item B B|B + +If I is set to B, the default, then the device name +seen by the guest will be used for reporting metrics. +This corresponds to the CtargetE> node in the XML definition of the +domain. + +If I is set to B, then metrics will be reported +using the path of the source, e.g. an image file. +This corresponds to the CsourceE> node in the XML definition of the +domain. + +B + +If the domain XML have the following device defined: + + + + + + +
+ + +Setting C will cause the I to be set +to C. +Setting C will cause the I to be set +to C. + +=item B B|B + +The B controls whether the full path or the +L of the source is being used as the I when +B is set to B. Defaults to B. + +B + +Assume the device path (source tag) is C. +Setting C will cause the I to +be set to C. +Setting C will cause the I to be +set to C. + =item B B When the virt plugin logs data, it sets the hostname of the collected data @@ -7823,6 +8129,38 @@ 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 +names. For example, the metric name C will +be shortened to C. + +=back + +=head2 Plugin C + +The C plugin writes metrics as INFO log messages. + +This plugin supports two output formats: I and I. + +Synopsis: + + + Format Graphite + + +=over 4 + +=item B I + +The output format to use. Can be one of C or C. + =back =head2 Plugin C @@ -7931,6 +8269,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 @@ -8164,6 +8537,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 @@ -9098,6 +9483,8 @@ Available options: =item B I +=item B I I + Match values where the given regular expressions match the various fields of the identifier of a value. If multiple regular expressions are given, B regexen must match for a value to match. @@ -9386,6 +9773,10 @@ Available options: =item B I I +=item B I I I + +=item B I I + Match the appropriate field with the given regular expression I. If the regular expression matches, that part that matches is replaced with I. If multiple places of the input buffer match a given regular @@ -9424,9 +9815,37 @@ Available options: =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. +Set the appropriate field to the given string. The strings for plugin instance, +type instance, and meta data 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. + +The following placeholders will be replaced by an appropriate value: + +=over 4 + +=item B<%{host}> + +=item B<%{plugin}> + +=item B<%{plugin_instance}> + +=item B<%{type}> + +=item B<%{type_instance}> + +These placeholders are replaced by the identifier field of the same name. + +=item B<%{meta:>IB<}> + +These placeholders are replaced by the meta data value with the given name. + +=back + +Please note that these placeholders are B! + +=item B I + +Delete the named meta data field. =back