enum

README

Enum Processor Plugin

The Enum Processor allows the configuration of value mappings for metric 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 and bool types for the field values. Multiple Fields can be configured with separate value mappings for each field. 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 field. By default the source field is overwritten.

Configuration:

[[processors.enum]]
  [[processors.enum.mapping]]
    ## Name of the field to map
    field = "status"

    ## Destination field to be used for the mapped value.  By default the source
    ## 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, the unmodified value for the field will be used if no
    ## match is found.
    # 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

Documentation

Index

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

Types

type EnumMapper

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

func (*EnumMapper) Apply

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

func (*EnumMapper) Description

func (mapper *EnumMapper) Description() string

func (*EnumMapper) SampleConfig

func (mapper *EnumMapper) SampleConfig() string

type Mapping

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