logfmt

README

Logfmt Parser Plugin

The logfmt data format parses data in logfmt format.

Configuration

[[inputs.file]]
  files = ["example"]

  ## Data format to consume.
  ## Each data format has its own unique set of configuration options, read
  ## more about them here:
  ##   https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
  data_format = "logfmt"

  ## Array of key names which should be collected as tags. Globs accepted.
  logfmt_tag_keys = ["method","host"]

Metrics

Each key/value pair in the line is added to a new metric as a field. The type of the field is automatically determined based on the contents of the value.

Examples

- method=GET host=example.org ts=2018-07-24T19:43:40.275Z connect=4ms service=8ms status=200 bytes=1653
+ logfmt,host=example.org,method=GET ts="2018-07-24T19:43:40.275Z",connect="4ms",service="8ms",status=200i,bytes=1653i

Documentation

Index

• Variables
• type Parser
  • func NewParser(metricName string, defaultTags map[string]string, tagKeys []string) *Parser
  • func (p *Parser) Init() error
  • func (p *Parser) Parse(b []byte) ([]telegraf.Metric, error)
  • func (p *Parser) ParseLine(s string) (telegraf.Metric, error)
  • func (p *Parser) SetDefaultTags(tags map[string]string)

Variables

var (
	ErrNoMetric = fmt.Errorf("no metric in line")
)

Types

type Parser

type Parser struct {
	TagKeys []string `toml:"logfmt_tag_keys"`

	MetricName  string
	DefaultTags map[string]string
	Now         func() time.Time
	// contains filtered or unexported fields
}

Parser decodes logfmt formatted messages into metrics.

func NewParser

func NewParser(metricName string, defaultTags map[string]string, tagKeys []string) *Parser

NewParser creates a parser.

func (*Parser) Init

func (p *Parser) Init() error

func (*Parser) Parse

func (p *Parser) Parse(b []byte) ([]telegraf.Metric, error)

Parse converts a slice of bytes in logfmt format to metrics.

func (*Parser) ParseLine

func (p *Parser) ParseLine(s string) (telegraf.Metric, error)

ParseLine converts a single line of text in logfmt format to metrics.

func (*Parser) SetDefaultTags

func (p *Parser) SetDefaultTags(tags map[string]string)

SetDefaultTags adds tags to the metrics outputs of Parse and ParseLine.