aggregator

Documentation

Index

• func GetProcessorConstructor(fun string) (func(val float64, ts uint32) Processor, error)
• func InitMetrics()
• type Aggregator
  • func New(fun, regex, prefix, sub, outFmt string, cache bool, interval, wait uint, ...) (*Aggregator, error)
  • func NewMocked(fun, regex, prefix, sub, outFmt string, cache bool, interval, wait uint, ...) (*Aggregator, error)
  • func (a *Aggregator) AddMaybe(buf [][]byte, val float64, ts uint32) bool
  • func (a *Aggregator) AddOrCreate(key string, ts uint32, quantized uint, value float64)
  • func (a *Aggregator) Flush(cutoff uint)
  • func (a *Aggregator) PreMatch(buf []byte) bool
  • func (a *Aggregator) Shutdown()
  • func (a *Aggregator) Snapshot() *Aggregator
• type Avg
  • func (a *Avg) Add(val float64, ts uint32)
  • func (a *Avg) Flush() ([]processorResult, bool)
• type CacheEntry
• type Count
  • func (c *Count) Add(val float64, ts uint32)
  • func (c *Count) Flush() ([]processorResult, bool)
• type Delta
  • func (d *Delta) Add(val float64, ts uint32)
  • func (d *Delta) Flush() ([]processorResult, bool)
• type Derive
  • func (d *Derive) Add(val float64, ts uint32)
  • func (d *Derive) Flush() ([]processorResult, bool)
• type Last
  • func (l *Last) Add(val float64, ts uint32)
  • func (l *Last) Flush() ([]processorResult, bool)
• type Max
  • func (m *Max) Add(val float64, ts uint32)
  • func (m *Max) Flush() ([]processorResult, bool)
• type Min
  • func (m *Min) Add(val float64, ts uint32)
  • func (m *Min) Flush() ([]processorResult, bool)
• type Percentiles
  • func (p *Percentiles) Add(val float64, ts uint32)
  • func (p *Percentiles) Flush() ([]processorResult, bool)
• type Processor
  • func NewAvg(val float64, ts uint32) Processor
  • func NewCount(val float64, ts uint32) Processor
  • func NewDelta(val float64, ts uint32) Processor
  • func NewDerive(val float64, ts uint32) Processor
  • func NewLast(val float64, ts uint32) Processor
  • func NewMax(val float64, ts uint32) Processor
  • func NewMin(val float64, ts uint32) Processor
  • func NewPercentiles(val float64, ts uint32) Processor
  • func NewStdev(val float64, ts uint32) Processor
  • func NewSum(val float64, ts uint32) Processor
• type RangeTracker
  • func NewRangeTracker() *RangeTracker
  • func (m *RangeTracker) Run()
  • func (m *RangeTracker) Sample(ts uint32)
• type Stdev
  • func (s *Stdev) Add(val float64, ts uint32)
  • func (s *Stdev) Flush() ([]processorResult, bool)
• type Sum
  • func (s *Sum) Add(val float64, ts uint32)
  • func (s *Sum) Flush() ([]processorResult, bool)
• type TsSlice
  • func (p TsSlice) Len() int
  • func (p TsSlice) Less(i, j int) bool
  • func (p TsSlice) Swap(i, j int)

Functions

func GetProcessorConstructor

func GetProcessorConstructor(fun string) (func(val float64, ts uint32) Processor, error)

func InitMetrics

func InitMetrics()

Types

type Aggregator

type Aggregator struct {
	Fun string `json:"fun"`

	Regex  string `json:"regex,omitempty"`
	Prefix string `json:"prefix,omitempty"`
	Sub    string `json:"substring,omitempty"`

	OutFmt string

	Cache bool

	Interval uint // expected interval between values in seconds, we will quantize to make sure alginment to interval-spaced timestamps
	Wait     uint // seconds to wait after quantized time value before flushing final outcome and ignoring future values that are sent too late.
	DropRaw  bool // drop raw values "consumed" by this aggregator

	Key string
	// contains filtered or unexported fields
}

func New

func New(fun, regex, prefix, sub, outFmt string, cache bool, interval, wait uint, dropRaw bool, out chan []byte) (*Aggregator, error)

New creates an aggregator

func NewMocked

func NewMocked(fun, regex, prefix, sub, outFmt string, cache bool, interval, wait uint, dropRaw bool, out chan []byte, inBuf int, now func() time.Time, tick <-chan time.Time) (*Aggregator, error)

func (*Aggregator) AddMaybe

func (a *Aggregator) AddMaybe(buf [][]byte, val float64, ts uint32) bool

func (*Aggregator) AddOrCreate

func (a *Aggregator) AddOrCreate(key string, ts uint32, quantized uint, value float64)

func (*Aggregator) Flush

func (a *Aggregator) Flush(cutoff uint)

Flush finalizes and removes aggregations that are due

func (*Aggregator) PreMatch

func (a *Aggregator) PreMatch(buf []byte) bool

PreMatch checks if the specified metric matches the specified prefix and/or substring If prefix isn't explicitly specified it will be derived from the regex where possible. If this returns false the metric will not be passed through to the main regex matching stage.

func (*Aggregator) Shutdown

func (a *Aggregator) Shutdown()

func (*Aggregator) Snapshot

func (a *Aggregator) Snapshot() *Aggregator

to view the state of the aggregator at any point in time

type Avg

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

Avg aggregates to average

func (*Avg) Add

func (a *Avg) Add(val float64, ts uint32)

func (*Avg) Flush

func (a *Avg) Flush() ([]processorResult, bool)

type CacheEntry

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

type Count

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

Count aggregates to the number of values seen

func (*Count) Add

func (c *Count) Add(val float64, ts uint32)

func (*Count) Flush

func (c *Count) Flush() ([]processorResult, bool)

type Delta

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

Delta aggregates to the difference between highest and lowest value seen

func (*Delta) Add

func (d *Delta) Add(val float64, ts uint32)

func (*Delta) Flush

func (d *Delta) Flush() ([]processorResult, bool)

type Derive

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

Derive aggregates to the derivative of the largest timeframe we get

func (*Derive) Add

func (d *Derive) Add(val float64, ts uint32)

func (*Derive) Flush

func (d *Derive) Flush() ([]processorResult, bool)

type Last

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

Last aggregates to the last value seen

func (*Last) Add

func (l *Last) Add(val float64, ts uint32)

func (*Last) Flush

func (l *Last) Flush() ([]processorResult, bool)

type Max

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

Max aggregates to the highest value seen

func (*Max) Add

func (m *Max) Add(val float64, ts uint32)

func (*Max) Flush

func (m *Max) Flush() ([]processorResult, bool)

type Min

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

Min aggregates to the lowest value seen

func (*Min) Add

func (m *Min) Add(val float64, ts uint32)

func (*Min) Flush

func (m *Min) Flush() ([]processorResult, bool)

type Percentiles

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

Percentiles aggregates to different percentiles

func (*Percentiles) Add

func (p *Percentiles) Add(val float64, ts uint32)

func (*Percentiles) Flush

func (p *Percentiles) Flush() ([]processorResult, bool)

Using the latest recommendation from NIST See https://www.itl.nist.gov/div898/handbook/prc/section2/prc262.htm The method implemented corresponds to method R6 of Hyndman and Fan. See https://en.wikipedia.org/wiki/Percentile, Third variant

type Processor

type Processor interface {
	// Add adds a point to aggregate
	Add(val float64, ts uint32)
	// Flush returns the aggregated value(s) and true if it is valid
	// the only reason why it would be non-valid is for aggregators that need
	// more than 1 value but they didn't have enough to produce a useful result.
	Flush() ([]processorResult, bool)
}

func NewAvg

func NewAvg(val float64, ts uint32) Processor

func NewCount

func NewCount(val float64, ts uint32) Processor

func NewDelta

func NewDelta(val float64, ts uint32) Processor

func NewDerive

func NewDerive(val float64, ts uint32) Processor

func NewLast

func NewLast(val float64, ts uint32) Processor

func NewMax

func NewMax(val float64, ts uint32) Processor

func NewMin

func NewMin(val float64, ts uint32) Processor

func NewPercentiles

func NewPercentiles(val float64, ts uint32) Processor

func NewStdev

func NewStdev(val float64, ts uint32) Processor

func NewSum

func NewSum(val float64, ts uint32) Processor

type RangeTracker

type RangeTracker struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewRangeTracker

func NewRangeTracker() *RangeTracker

func (*RangeTracker) Run

func (m *RangeTracker) Run()

func (*RangeTracker) Sample

func (m *RangeTracker) Sample(ts uint32)

type Stdev

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

Stdev aggregates to standard deviation

func (*Stdev) Add

func (s *Stdev) Add(val float64, ts uint32)

func (*Stdev) Flush

func (s *Stdev) Flush() ([]processorResult, bool)

type Sum

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

Sum aggregates to sum

func (*Sum) Add

func (s *Sum) Add(val float64, ts uint32)

func (*Sum) Flush

func (s *Sum) Flush() ([]processorResult, bool)

type TsSlice

type TsSlice []uint

func (TsSlice) Len

func (p TsSlice) Len() int

func (TsSlice) Less

func (p TsSlice) Less(i, j int) bool

func (TsSlice) Swap

func (p TsSlice) Swap(i, j int)