template

README

Template Processor

The template processor applies a Go template to metrics to generate a new tag. The primary use case of this plugin is to create a tag that can be used for dynamic routing to multiple output plugins or using an output specific routing option.

The template has access to each metric's measurement name, tags, fields, and timestamp using the interface in /template_metric.go.

Read the full Go Template Documentation.

Configuration

[[processors.template]]
  ## Tag to set with the output of the template.
  tag = "topic"

  ## Go template used to create the tag value.  In order to ease TOML
  ## escaping requirements, you may wish to use single quotes around the
  ## template string.
  template = '{{ .Tag "hostname" }}.{{ .Tag "level" }}'

Example

Combine multiple tags to create a single tag:

[[processors.template]]
  tag = "topic"
  template = '{{ .Tag "hostname" }}.{{ .Tag "level" }}'

- cpu,level=debug,hostname=localhost time_idle=42
+ cpu,level=debug,hostname=localhost,topic=localhost.debug time_idle=42

Add measurement name as a tag:

[[processors.template]]
  tag = "measurement"
  template = '{{ .Name }}'

- cpu,hostname=localhost time_idle=42
+ cpu,hostname=localhost,measurement=cpu time_idle=42

Add the year as a tag, similar to the date processor:

[[processors.template]]
  tag = "year"
  template = '{{.Time.UTC.Year}}'

Documentation

Index

• type TemplateMetric
  • func (m *TemplateMetric) Field(key string) interface{}
  • func (m *TemplateMetric) Name() string
  • func (m *TemplateMetric) Tag(key string) string
  • func (m *TemplateMetric) Time() time.Time
• type TemplateProcessor
  • func (r *TemplateProcessor) Apply(in ...telegraf.Metric) []telegraf.Metric
  • func (r *TemplateProcessor) Description() string
  • func (r *TemplateProcessor) Init() error
  • func (r *TemplateProcessor) SampleConfig() string

Types

type TemplateMetric

type TemplateMetric struct {
	// contains filtered or unexported fields
}

func (*TemplateMetric) Field

func (m *TemplateMetric) Field(key string) interface{}

func (*TemplateMetric) Name

func (m *TemplateMetric) Name() string

func (*TemplateMetric) Tag

func (m *TemplateMetric) Tag(key string) string

func (*TemplateMetric) Time

func (m *TemplateMetric) Time() time.Time

type TemplateProcessor

type TemplateProcessor struct {
	Tag      string          `toml:"tag"`
	Template string          `toml:"template"`
	Log      telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func (*TemplateProcessor) Apply

func (r *TemplateProcessor) Apply(in ...telegraf.Metric) []telegraf.Metric

func (*TemplateProcessor) Description

func (r *TemplateProcessor) Description() string

func (*TemplateProcessor) Init

func (r *TemplateProcessor) Init() error

func (*TemplateProcessor) SampleConfig

func (r *TemplateProcessor) SampleConfig() string