telegraf/plugins/processors/override
Sebastian Spaink be0008f9e2
feat: migrate processor plugins to new sample config format (#10913)
2022-04-06 14:49:41 -06:00
..
README.md chore: clean up all markdown lint errors in processor plugins (#10157) 2021-11-24 11:47:11 -07:00
override.go feat: migrate processor plugins to new sample config format (#10913) 2022-04-06 14:49:41 -06:00
override_sample_config.go feat: migrate processor plugins to new sample config format (#10913) 2022-04-06 14:49:41 -06:00
override_test.go fix: Linter fixes for plugins/processors/[a-z]* (#10161) 2021-11-24 12:38:08 -07:00

README.md

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 measurement 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.

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"