defaults

README

Defaults Processor Plugin

The Defaults processor allows you to ensure certain fields will always exist with a specified default value on your metric(s).

There are three cases where this processor will insert a configured default field.

1. The field is nil on the incoming metric
2. The field is not nil, but its value is an empty string.
3. The field is not nil, but its value is a string of one or more empty spaces.

Telegraf minimum version: Telegraf 1.15.0

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

## Set default fields on your metric(s) when they are nil or empty
[[processors.defaults]]
  ## Ensures a set of fields always exists on your metric(s) with their
  ## respective default value.
  ## For any given field pair (key = default), if it's not set, a field
  ## is set on the metric with the specified default.
  ##
  ## A field is considered not set if it is nil on the incoming metric;
  ## or it is not nil but its value is an empty string or is a string
  ## of one or more spaces.
  ##   <target-field> = <value>
  [processors.defaults.fields]
    field_1 = "bar"
    time_idle = 0
    is_error = true

Example

Ensure a status_code field with N/A is inserted in the metric when one is not set in the metric by default:

[[processors.defaults]]
  [processors.defaults.fields]
    status_code = "N/A"

- lb,http_method=GET cache_status=HIT,latency=230
+ lb,http_method=GET cache_status=HIT,latency=230,status_code="N/A"

Ensure an empty string gets replaced by a default:

- lb,http_method=GET cache_status=HIT,latency=230,status_code=""
+ lb,http_method=GET cache_status=HIT,latency=230,status_code="N/A"

Documentation

Index

• type Defaults
  • func (def *Defaults) Apply(inputMetrics ...telegraf.Metric) []telegraf.Metric
  • func (*Defaults) SampleConfig() string

Types

type Defaults

type Defaults struct {
	DefaultFieldsSets map[string]interface{} `toml:"fields"`
}

Defaults is a processor for ensuring certain fields always exist on your Metrics with at least a default value.

func (*Defaults) Apply

func (def *Defaults) Apply(inputMetrics ...telegraf.Metric) []telegraf.Metric

Apply contains the main implementation of this processor. For each metric in 'inputMetrics', it goes over each default pair. If the field in the pair does not exist on the metric, the associated default is added. If the field was found, then, if its value is the empty string or one or more spaces, it is replaced by the associated default.

func (*Defaults) SampleConfig

func (*Defaults) SampleConfig() string