filter

README

Filter Processor Plugin

The filter processor plugin allows to specify a set of rules for metrics with the ability to keep or drop those metrics. It does not change the metric. As such a user might want to apply this processor to remove metrics from the processing/output stream. NOTE: The filtering is not output specific, but will apply to the metrics processed by this processor.

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Filter metrics by the given criteria
[[processors.filter]]
    ## Default action if no rule applies
    # default = "pass"

    ## Rules to apply on the incoming metrics (multiple rules are possible)
    ## The rules are evaluated in order and the first matching rule is applied.
    ## In case no rule matches the "default" is applied.
    ## All filter criteria in a rule must apply for the rule to match the metric
    ## i.e. the criteria are combined by a logical AND. If a criterion is
    ## omitted it is NOT applied at all and ignored.
    [[processors.filter.rule]]
        ## List of metric names to match including glob expressions
        # name = []

        ## List of tag key/values pairs to match including glob expressions
        ## ALL given tags keys must exist and at least one value must match
        ## for the metric to match the rule.
        # tags = {}

        ## List of field keys to match including glob expressions
        ## At least one field must exist for the metric to match the rule.
        # fields = []

        ## Action to apply for this rule
        ## "pass" will keep the metric and pass it on, while "drop" will remove
        ## the metric
        # action = "drop"

Examples

Consider a use-case where you collected a bunch of metrics

machine,source="machine1",status="OK" operating_hours=37i,temperature=23.1
machine,source="machine2",status="warning" operating_hours=1433i,temperature=48.9,message="too hot"
machine,source="machine3",status="OK" operating_hours=811i,temperature=29.5
machine,source="machine4",status="failure" operating_hours=1009i,temperature=67.3,message="temperature alert"

but only want to keep the ones indicating a status of failure or warning:

[[processors.filter]]
  namepass = ["machine"]
  default = "drop"

  [[processors.filter.rule]]
    tags = {"status" = ["warning", "failure"]}
    action = "pass"

Alternatively, you can "black-list" the OK value via

[[processors.filter]]
  namepass = ["machine"]

  [[processors.filter.rule]]
    tags = {"status" = "OK"}

Documentation

Index

• type Filter
  • func (f *Filter) Apply(in ...telegraf.Metric) []telegraf.Metric
  • func (f *Filter) Init() error
  • func (*Filter) SampleConfig() string

Types

type Filter

type Filter struct {
	Rules         []rule          `toml:"rule"`
	DefaultAction string          `toml:"default"`
	Log           telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func (*Filter) Apply

func (f *Filter) Apply(in ...telegraf.Metric) []telegraf.Metric

func (*Filter) Init

func (f *Filter) Init() error

func (*Filter) SampleConfig

func (*Filter) SampleConfig() string