aggregation

Documentation

Index

• type Counter
  • func NewCounter(opts Options) Counter
  • func (c *Counter) Close()
  • func (c *Counter) Count() int64
  • func (c *Counter) LastAt() time.Time
  • func (c *Counter) Max() int64
  • func (c *Counter) Mean() float64
  • func (c *Counter) Min() int64
  • func (c *Counter) Stdev() float64
  • func (c *Counter) Sum() int64
  • func (c *Counter) SumSq() int64
  • func (c *Counter) Update(timestamp time.Time, value int64)
  • func (c *Counter) ValueOf(aggType aggregation.Type) float64
• type CounterMetrics
  • func (m CounterMetrics) IncValuesOutOfOrder()
• type Gauge
  • func NewGauge(opts Options) Gauge
  • func (g *Gauge) Close()
  • func (g *Gauge) Count() int64
  • func (g *Gauge) Last() float64
  • func (g *Gauge) LastAt() time.Time
  • func (g *Gauge) Max() float64
  • func (g *Gauge) Mean() float64
  • func (g *Gauge) Min() float64
  • func (g *Gauge) Stdev() float64
  • func (g *Gauge) Sum() float64
  • func (g *Gauge) SumSq() float64
  • func (g *Gauge) Update(timestamp time.Time, value float64)
  • func (g *Gauge) ValueOf(aggType aggregation.Type) float64
• type GaugeMetrics
  • func (m GaugeMetrics) IncValuesOutOfOrder()
• type Metrics
  • func NewMetrics(scope tally.Scope) Metrics
• type Options
  • func NewOptions(instrumentOpts instrument.Options) Options
  • func (o *Options) ResetSetData(aggTypes aggregation.Types)
• type Timer
  • func NewTimer(quantiles []float64, streamOpts cm.Options, opts Options) Timer
  • func (t *Timer) Add(timestamp time.Time, value float64)
  • func (t *Timer) AddBatch(timestamp time.Time, values []float64)
  • func (t *Timer) Close()
  • func (t *Timer) Count() int64
  • func (t *Timer) LastAt() time.Time
  • func (t *Timer) Max() float64
  • func (t *Timer) Mean() float64
  • func (t *Timer) Min() float64
  • func (t *Timer) Quantile(q float64) float64
  • func (t *Timer) Stdev() float64
  • func (t *Timer) Sum() float64
  • func (t *Timer) SumSq() float64
  • func (t *Timer) ValueOf(aggType aggregation.Type) float64

Types

type Counter

type Counter struct {
	Options
	// contains filtered or unexported fields
}

Counter aggregates counter values.

func NewCounter

func NewCounter(opts Options) Counter

NewCounter creates a new counter.

func (*Counter) Close

func (c *Counter) Close()

Close closes the counter.

func (*Counter) Count

func (c *Counter) Count() int64

Count returns the number of values received.

func (*Counter) LastAt

func (c *Counter) LastAt() time.Time

LastAt returns the time of the last value received.

func (*Counter) Max

func (c *Counter) Max() int64

Max returns the maximum counter value.

func (*Counter) Mean

func (c *Counter) Mean() float64

Mean returns the mean counter value.

func (*Counter) Min

func (c *Counter) Min() int64

Min returns the minimum counter value.

func (*Counter) Stdev

func (c *Counter) Stdev() float64

Stdev returns the standard deviation counter value.

func (*Counter) Sum

func (c *Counter) Sum() int64

Sum returns the sum of counter values.

func (*Counter) SumSq

func (c *Counter) SumSq() int64

SumSq returns the squared sum of counter values.

func (*Counter) Update

func (c *Counter) Update(timestamp time.Time, value int64)

Update updates the counter value.

func (*Counter) ValueOf

func (c *Counter) ValueOf(aggType aggregation.Type) float64

ValueOf returns the value for the aggregation type.

type CounterMetrics

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

CounterMetrics is a set of counter metrics can be used by all counters.

func (CounterMetrics) IncValuesOutOfOrder

func (m CounterMetrics) IncValuesOutOfOrder()

IncValuesOutOfOrder increments value or if not initialized is a no-op.

type Gauge

type Gauge struct {
	Options
	// contains filtered or unexported fields
}

Gauge aggregates gauge values.

func NewGauge

func NewGauge(opts Options) Gauge

NewGauge creates a new gauge.

func (*Gauge) Close

func (g *Gauge) Close()

Close closes the gauge.

func (*Gauge) Count

func (g *Gauge) Count() int64

Count returns the number of values received.

func (*Gauge) Last

func (g *Gauge) Last() float64

Last returns the last value received.

func (*Gauge) LastAt

func (g *Gauge) LastAt() time.Time

LastAt returns the time of the last value received.

func (*Gauge) Max

func (g *Gauge) Max() float64

Max returns the maximum gauge value.

func (*Gauge) Mean

func (g *Gauge) Mean() float64

Mean returns the mean gauge value.

func (*Gauge) Min

func (g *Gauge) Min() float64

Min returns the minimum gauge value.

func (*Gauge) Stdev

func (g *Gauge) Stdev() float64

Stdev returns the standard deviation gauge value.

func (*Gauge) Sum

func (g *Gauge) Sum() float64

Sum returns the sum of gauge values.

func (*Gauge) SumSq

func (g *Gauge) SumSq() float64

SumSq returns the squared sum of gauge values.

func (*Gauge) Update

func (g *Gauge) Update(timestamp time.Time, value float64)

Update updates the gauge value.

func (*Gauge) ValueOf

func (g *Gauge) ValueOf(aggType aggregation.Type) float64

ValueOf returns the value for the aggregation type.

type GaugeMetrics

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

GaugeMetrics is a set of gauge metrics can be used by all gauges.

func (GaugeMetrics) IncValuesOutOfOrder

func (m GaugeMetrics) IncValuesOutOfOrder()

IncValuesOutOfOrder increments value or if not initialized is a no-op.

type Metrics

type Metrics struct {
	Counter CounterMetrics
	Gauge   GaugeMetrics
}

Metrics is a set of metrics that can be used by elements.

func NewMetrics

func NewMetrics(scope tally.Scope) Metrics

NewMetrics is a set of aggregation metrics.

type Options

type Options struct {
	// HasExpensiveAggregations means expensive (multiplication／division)
	// aggregation types are enabled.
	HasExpensiveAggregations bool
	// Metrics is as set of aggregation metrics.
	Metrics Metrics
}

Options is the options for aggregations.

func NewOptions

func NewOptions(instrumentOpts instrument.Options) Options

NewOptions creates a new aggregation options.

func (*Options) ResetSetData

func (o *Options) ResetSetData(aggTypes aggregation.Types)

ResetSetData resets the aggregation options.

type Timer

type Timer struct {
	Options
	// contains filtered or unexported fields
}

Timer aggregates timer values. Timer APIs are not thread-safe.

func NewTimer

func NewTimer(quantiles []float64, streamOpts cm.Options, opts Options) Timer

NewTimer creates a new timer

func (*Timer) Add

func (t *Timer) Add(timestamp time.Time, value float64)

Add adds a timer value.

func (*Timer) AddBatch

func (t *Timer) AddBatch(timestamp time.Time, values []float64)

AddBatch adds a batch of timer values.

func (*Timer) Close

func (t *Timer) Close()

Close closes the timer.

func (*Timer) Count

func (t *Timer) Count() int64

Count returns the number of values received.

func (*Timer) LastAt

func (t *Timer) LastAt() time.Time

LastAt returns the time of the last value received.

func (*Timer) Max

func (t *Timer) Max() float64

Max returns the maximum timer value.

func (*Timer) Mean

func (t *Timer) Mean() float64

Mean returns the mean timer value.

func (*Timer) Min

func (t *Timer) Min() float64

Min returns the minimum timer value.

func (*Timer) Quantile

func (t *Timer) Quantile(q float64) float64

Quantile returns the value at a given quantile.

func (*Timer) Stdev

func (t *Timer) Stdev() float64

Stdev returns the standard deviation timer value.

func (*Timer) Sum

func (t *Timer) Sum() float64

Sum returns the sum of timer values.

func (*Timer) SumSq

func (t *Timer) SumSq() float64

SumSq returns the squared sum of timer values.

func (*Timer) ValueOf

func (t *Timer) ValueOf(aggType aggregation.Type) float64

ValueOf returns the value for the aggregation type.