tag_limit

README

Tag Limit Processor Plugin

Use the tag_limit processor to ensure that only a certain number of tags are preserved for any given metric, and to choose the tags to preserve when the number of tags appended by the data source is over the limit.

This can be useful when dealing with output systems (e.g. Stackdriver) that impose hard limits on the number of tags/labels per metric or where high levels of cardinality are computationally and/or financially expensive.

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

# Restricts the number of tags that can pass through this filter and chooses which tags to preserve when over the limit.
[[processors.tag_limit]]
  ## Maximum number of tags to preserve
  limit = 3

  ## List of tags to preferentially preserve
  keep = ["environment", "region"]

Example

+ throughput month=Jun,environment=qa,region=us-east1,lower=10i,upper=1000i,mean=500i 1560540094000000000
+ throughput environment=qa,region=us-east1,lower=10i 1560540094000000000

Documentation

Index

• type TagLimit
  • func (d *TagLimit) Apply(in ...telegraf.Metric) []telegraf.Metric
  • func (*TagLimit) SampleConfig() string

Types

type TagLimit

type TagLimit struct {
	Limit int             `toml:"limit"`
	Keep  []string        `toml:"keep"`
	Log   telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func (*TagLimit) Apply

func (d *TagLimit) Apply(in ...telegraf.Metric) []telegraf.Metric

func (*TagLimit) SampleConfig

func (*TagLimit) SampleConfig() string