override

package
v1.30.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 22, 2024 License: MIT Imports: 3 Imported by: 5

README

Override Processor Plugin

The override processor plugin allows overriding all modifications that are supported by input plugins and aggregators:

  • name_override
  • name_prefix
  • name_suffix
  • tags

All metrics passing through this processor will be modified accordingly. Select the metrics to modify using the standard metric filtering options.

Values of name_override, name_prefix, name_suffix and already present tags with conflicting keys will be overwritten. Absent tags will be created.

Use-case of this plugin encompass ensuring certain tags or naming conventions are adhered to irrespective of input plugin configurations, e.g. by taginclude.

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

# Apply metric modifications using override semantics.
[[processors.override]]
  ## All modifications on inputs and aggregators can be overridden:
  # name_override = "new_name"
  # name_prefix = "new_name_prefix"
  # name_suffix = "new_name_suffix"

  ## Tags to be added (all values must be strings)
  # [processors.override.tags]
  #   additional_tag = "tag_value"

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Override

type Override struct {
	NameOverride string            `toml:"name_override"`
	NamePrefix   string            `toml:"name_prefix"`
	NameSuffix   string            `toml:"name_suffix"`
	Tags         map[string]string `toml:"tags"`
}

func (*Override) Apply

func (p *Override) Apply(in ...telegraf.Metric) []telegraf.Metric

func (*Override) SampleConfig

func (*Override) SampleConfig() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL