enum

README

Enum Processor Plugin

The Enum Processor allows the configuration of value mappings for metric tags or fields. The main use-case for this is to rewrite status codes such as red, amber and green by numeric values such as 0, 1, 2. The plugin supports string, int, float64 and bool types for the field values. Multiple tags or fields can be configured with separate value mappings for each. Default mapping values can be configured to be used for all values, which are not contained in the value_mappings. The processor supports explicit configuration of a destination tag or field. By default the source tag or field is overwritten.

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

# Map enum values according to given table.
[[processors.enum]]
  [[processors.enum.mapping]]
    ## Name of the field to map. Globs accepted.
    field = "status"

    ## Name of the tag to map. Globs accepted.
    # tag = "status"

    ## Destination tag or field to be used for the mapped value.  By default the
    ## source tag or field is used, overwriting the original value.
    dest = "status_code"

    ## Default value to be used for all values not contained in the mapping
    ## table.  When unset and no match is found, the original field will remain
    ## unmodified and the destination tag or field will not be created.
    # default = 0

    ## Table of mappings
    [processors.enum.mapping.value_mappings]
      green = 1
      amber = 2
      red = 3

Example

- xyzzy status="green" 1502489900000000000
+ xyzzy status="green",status_code=1i 1502489900000000000

With unknown value and no default set:

- xyzzy status="black" 1502489900000000000
+ xyzzy status="black" 1502489900000000000

Documentation

Index

• type EnumMapper
  • func (mapper *EnumMapper) Apply(in ...telegraf.Metric) []telegraf.Metric
  • func (mapper *EnumMapper) Init() error
  • func (*EnumMapper) SampleConfig() string
• type Mapping

Types

type EnumMapper

type EnumMapper struct {
	Mappings []Mapping `toml:"mapping"`

	FieldFilters map[string]filter.Filter
	TagFilters   map[string]filter.Filter
}

func (*EnumMapper) Apply

func (mapper *EnumMapper) Apply(in ...telegraf.Metric) []telegraf.Metric

func (*EnumMapper) Init

func (mapper *EnumMapper) Init() error

func (*EnumMapper) SampleConfig

func (*EnumMapper) SampleConfig() string

type Mapping

type Mapping struct {
	Tag           string
	Field         string
	Dest          string
	Default       interface{}
	ValueMappings map[string]interface{}
}