Match: value¶


Plugin name	`match_value`
Status	supported
Since	4.6
Copyright	2008 Florian octo Forster
License	GPLv2
Configuration	collectd.conf(5)

Description¶

The Value match matches value lists by the actual values they contain, using minimum and maximum thresholds. If the value-list contains multiple values (data-sources), you can select whether all or any data sources need to match for a successful match. This match is usually used in conjunction with the RegEx match.

This match only works with the values converted to a rate. If you match network traffic, for example, which is usually provided as a counter value, this match will not work with the actual (integer) counter value, but with the rate, the change over time. (Academics like to call this the time differential.) The conversion is done using the global value cache. (Academics: Finite difference. ;) Using this match in the PreCache chain therefore only works reliably for gauge values! See Chains#Pre--and-post-cache-chains for details.

Synopsis¶

 <Match "value">
   Min   0
   Max 100
   Invert true
   Satisfy "Any"
 </Match>

Match if the value of any data source is outside the range of 0–100.

Dependencies¶

none

History¶

The Value match has been available since version 4.6.0.

Configuration¶

Configuration options · from collectd.conf(5)

See this section in the full configuration reference

Matches the actual value of data sources against given minimumE<nbsp>/ maximum values. If a data-set consists of more than one data-source, all data-sources must match the specified ranges for a positive match.

Available options:

Min Value

Sets the smallest value which still results in a match. If unset, behaves like negative infinity.

Max Value

Sets the largest value which still results in a match. If unset, behaves like positive infinity.

Invert true|false

Inverts the selection. If the Min and Max settings result in a match, no-match is returned and vice versa. Please note that the Invert setting only effects how Min and Max are applied to a specific value. Especially the DataSource and Satisfy settings (see below) are not inverted.

DataSource DSName [DSName ...]

Select one or more of the data sources. If no data source is configured, all data sources will be checked. If the type handled by the match does not have a data source of the specified name(s), this will always result in no match (independent of the Invert setting).

Satisfy Any|All

Specifies how checking with several data sources is performed. If set to Any, the match succeeds if one of the data sources is in the configured range. If set to All the match only succeeds if all data sources are within the configured range. Default is All.

Usually All is used for positive matches, Any is used for negative matches. This means that with All you usually check that all values are in a "good" range, while with Any you check if any value is within a "bad" range (or outside the "good" range).

Either Min or Max, but not both, may be unset.

Example:

# Match all values smaller than or equal to 100. Matches only if all data
# sources are below 100.
<Match "value">
  Max 100
  Satisfy "All"
</Match>

# Match if the value of any data source is outside the range of 0 - 100.
<Match "value">
  Min   0
  Max 100
  Invert true
  Satisfy "Any"
</Match>