valuecounter

README

ValueCounter Aggregator Plugin

The valuecounter plugin counts the occurrence of values in fields and emits the counter once every 'period' seconds.

A use case for the valuecounter plugin is when you are processing a HTTP access log (with the logparser input) and want to count the HTTP status codes.

The fields which will be counted must be configured with the fields configuration directive. When no fields is provided the plugin will not count any fields. The results are emitted in fields in the format: originalfieldname_fieldvalue = count.

Counting fields with a high number of potential values may produce significant amounts of new fields and memory usage, take care to only count fields with a limited set of values.

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

# Count the occurrence of values in fields.
[[aggregators.valuecounter]]
  ## General Aggregator Arguments:
  ## The period on which to flush & clear the aggregator.
  period = "30s"
  ## If true, the original metric will be dropped by the
  ## aggregator and will not get sent to the output plugins.
  drop_original = false
  ## The fields for which the values will be counted
  fields = ["status"]

Measurements & Fields

• measurement1
  • field_value1
  • field_value2

Tags

No tags are applied by this aggregator.

Example Output

Example for parsing a HTTP access log.

telegraf.conf:

[[inputs.logparser]]
  files = ["/tmp/tst.log"]
  [inputs.logparser.grok]
    patterns = ['%{DATA:url:tag} %{NUMBER:response:string}']
    measurement = "access"

[[aggregators.valuecounter]]
  namepass = ["access"]
  fields = ["response"]

/tmp/tst.log

/some/path 200
/some/path 401
/some/path 200

access,url=/some/path,path=/tmp/tst.log,host=localhost.localdomain response="200" 1511948755991487011
access,url=/some/path,path=/tmp/tst.log,host=localhost.localdomain response="401" 1511948755991522282
access,url=/some/path,path=/tmp/tst.log,host=localhost.localdomain response="200" 1511948755991531697
access,path=/tmp/tst.log,host=localhost.localdomain,url=/some/path response_200=2i,response_401=1i 1511948761000000000

Documentation

Index

• func NewValueCounter() telegraf.Aggregator
• type ValueCounter
  • func (vc *ValueCounter) Add(in telegraf.Metric)
  • func (vc *ValueCounter) Push(acc telegraf.Accumulator)
  • func (vc *ValueCounter) Reset()
  • func (*ValueCounter) SampleConfig() string

Functions

func NewValueCounter

func NewValueCounter() telegraf.Aggregator

NewValueCounter create a new aggregation plugin which counts the occurrences of fields and emits the count.

Types

type ValueCounter

type ValueCounter struct {
	Fields []string
	// contains filtered or unexported fields
}

ValueCounter an aggregation plugin

func (*ValueCounter) Add

func (vc *ValueCounter) Add(in telegraf.Metric)

Add is run on every metric which passes the plugin

func (*ValueCounter) Push

func (vc *ValueCounter) Push(acc telegraf.Accumulator)

Push emits the counters

func (*ValueCounter) Reset

func (vc *ValueCounter) Reset()

Reset the cache, executed after each push

func (*ValueCounter) SampleConfig

func (*ValueCounter) SampleConfig() string