clone

package
v1.32.2 Latest Latest
Warning

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

Go to latest
Published: Oct 28, 2024 License: MIT Imports: 3 Imported by: 2

README

Clone Processor Plugin

The clone processor plugin create a copy of each metric passing through it, preserving untouched the original metric and allowing modifications in the copied one.

The modifications allowed are the ones supported by input plugins and aggregators:

  • name_override
  • name_prefix
  • name_suffix
  • tags

Select the metrics to modify using the standard metric filtering options. Filtering options apply to both the clone and the original.

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

A typical use-case is gathering metrics once and cloning them to simulate having several hosts (modifying host tag).

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.clone]]
  ## 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.clone.tags]
  #   additional_tag = "tag_value"

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Clone

type Clone struct {
	NameOverride string
	NamePrefix   string
	NameSuffix   string
	Tags         map[string]string
}

func (*Clone) Apply

func (c *Clone) Apply(in ...telegraf.Metric) []telegraf.Metric

func (*Clone) SampleConfig

func (*Clone) SampleConfig() string

Jump to

Keyboard shortcuts

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