basicstats

package
v0.0.0-...-6a73ad5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 1, 2019 License: MIT Imports: 4 Imported by: 0

README

BasicStats Aggregator Plugin

The BasicStats aggregator plugin give us count,max,min,mean,sum,s2(variance), stdev for a set of values, emitting the aggregate every period seconds.

Configuration:
# Keep the aggregate basicstats of each metric passing through.
[[aggregators.basicstats]]
  ## 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

  ## Configures which basic stats to push as fields
  # stats = ["count", "min", "max", "mean", "stdev", "s2", "sum"]
  • stats
    • If not specified, then count, min, max, mean, stdev, and s2 are aggregated and pushed as fields. sum is not aggregated by default to maintain backwards compatibility.
    • If empty array, no stats are aggregated
Measurements & Fields:
  • measurement1
    • field1_count
    • field1_max
    • field1_min
    • field1_mean
    • field1_sum
    • field1_s2 (variance)
    • field1_stdev (standard deviation)
Tags:

No tags are applied by this aggregator.

Example Output:
$ telegraf --config telegraf.conf --quiet
system,host=tars load1=1 1475583980000000000
system,host=tars load1=1 1475583990000000000
system,host=tars load1_count=2,load1_max=1,load1_min=1,load1_mean=1,load1_sum=2,load1_s2=0,load1_stdev=0 1475584010000000000
system,host=tars load1=1 1475584020000000000
system,host=tars load1=3 1475584030000000000
system,host=tars load1_count=2,load1_max=3,load1_min=1,load1_mean=2,load1_sum=4,load1_s2=2,load1_stdev=1.414162 1475584010000000000

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BasicStats

type BasicStats struct {
	Stats []string `toml:"stats"`
	// contains filtered or unexported fields
}

func NewBasicStats

func NewBasicStats() *BasicStats

func (*BasicStats) Add

func (m *BasicStats) Add(in telegraf.Metric)

func (*BasicStats) Description

func (m *BasicStats) Description() string

func (*BasicStats) Push

func (m *BasicStats) Push(acc telegraf.Accumulator)

func (*BasicStats) Reset

func (m *BasicStats) Reset()

func (*BasicStats) SampleConfig

func (m *BasicStats) SampleConfig() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL