timers.go

package gostatsd

import (
	"github.com/spf13/viper"
)

// Timer is used for storing aggregated values for timers.
type Timer struct {
	Count        int         // The number of timers in the series
	SampledCount float64     // Number of timings received, divided by sampling rate
	PerSecond    float64     // The calculated per second rate
	Mean         float64     // The mean time of the series
	Median       float64     // The median time of the series
	Min          float64     // The minimum time of the series
	Max          float64     // The maximum time of the series
	StdDev       float64     // The standard deviation for the series
	Sum          float64     // The sum for the series
	SumSquares   float64     // The sum squares for the series
	Values       []float64   // The numeric value of the metric
	Percentiles  Percentiles // The percentile aggregations of the metric
	Timestamp    Nanotime    // Last time value was updated
	Source       Source      // Hostname of the source of the metric
	Tags         Tags        // The tags for the timer

	// Map bounds to count of measures seen in that bucket.
	// This map only non-empty if the metric specifies histogram aggregation in its tags.
	Histogram map[HistogramThreshold]int
}

type HistogramThreshold float64

// NewTimer initialises a new timer.
func NewTimer(timestamp Nanotime, values []float64, source Source, tags Tags) Timer {
	return Timer{Values: values, Timestamp: timestamp, Source: source, Tags: tags.Copy(), SampledCount: float64(len(values))}
}

// NewTimerValues initialises a new timer only from Values array
func NewTimerValues(values []float64) Timer {
	return NewTimer(Nanotime(0), values, "", nil)
}

func (t *Timer) AddTagsSetSource(additionalTags Tags, newSource Source) {
	t.Tags = t.Tags.Concat(additionalTags)
	t.Source = newSource
}

// Timers stores a map of timers by tags.
type Timers map[string]map[string]Timer

// MetricsName returns the name of the aggregated metrics collection.
func (t Timers) MetricsName() string {
	return "Timers"
}

// Delete deletes the metrics from the collection.
func (t Timers) Delete(k string) {
	delete(t, k)
}

// DeleteChild deletes the metrics from the collection for the given tags.
func (t Timers) DeleteChild(k, tags string) {
	delete(t[k], tags)
}

// HasChildren returns whether there are more children nested under the key.
func (t Timers) HasChildren(k string) bool {
	return len(t[k]) != 0
}

// Each iterates over each timer.
func (t Timers) Each(f func(metricName string, tagsKey string, t Timer)) {
	for key, value := range t {
		for tags, timer := range value {
			f(key, tags, timer)
		}
	}
}

func DisabledSubMetrics(viper *viper.Viper) TimerSubtypes {
	subViper := viper.Sub("disabled-sub-metrics")
	if subViper == nil {
		return TimerSubtypes{}
	}

	subViper.SetDefault("lower", false)
	subViper.SetDefault("lower-pct", false)
	subViper.SetDefault("upper", false)
	subViper.SetDefault("upper-pct", false)
	subViper.SetDefault("count", false)
	subViper.SetDefault("count-pct", false)
	subViper.SetDefault("count-per-second", false)
	subViper.SetDefault("mean", false)
	subViper.SetDefault("mean-pct", false)
	subViper.SetDefault("median", false)
	subViper.SetDefault("std", false)
	subViper.SetDefault("sum", false)
	subViper.SetDefault("sum-pct", false)
	subViper.SetDefault("sum-squares", false)
	subViper.SetDefault("sum-squares-pct", false)

	return TimerSubtypes{
		Lower:          subViper.GetBool("lower"),
		LowerPct:       subViper.GetBool("lower-pct"),
		Upper:          subViper.GetBool("upper"),
		UpperPct:       subViper.GetBool("upper-pct"),
		Count:          subViper.GetBool("count"),
		CountPct:       subViper.GetBool("count-pct"),
		CountPerSecond: subViper.GetBool("count-per-second"),
		Mean:           subViper.GetBool("mean"),
		MeanPct:        subViper.GetBool("mean-pct"),
		Median:         subViper.GetBool("median"),
		StdDev:         subViper.GetBool("stddev"),
		Sum:            subViper.GetBool("sum"),
		SumPct:         subViper.GetBool("sum-pct"),
		SumSquares:     subViper.GetBool("sum-squares"),
		SumSquaresPct:  subViper.GetBool("sum-squares-pct"),
	}
}