awscsmmetrics

Documentation

Index

• Constants
• type FrequencyMetric
  • func NewFrequencyMetric(name string) FrequencyMetric
  • func (m *FrequencyMetric) CountSample(k string)
• type FrequencyMetrics
• type Metric
• type SEHMetric
  • func NewSEHMetric(name string) SEHMetric
  • func (m *SEHMetric) AddSample(value float64) error
  • func (m *SEHMetric) AddWeightedSample(v float64, weight float64) error
• type SEHMetrics
• type StatisticSet
  • func NewStatisticSet(value float64) StatisticSet
  • func NewWeightedStatisticSet(value float64, weight float64) StatisticSet
  • func (this *StatisticSet) Merge(other StatisticSet) error

Constants

const (
	ZeroBucket = int64(-32768)
)

Types

type FrequencyMetric

type FrequencyMetric struct {
	Name        string
	Frequencies map[string]int64
}

FrequencyMetric represents a metric that is a numeric value.

func NewFrequencyMetric

func NewFrequencyMetric(name string) FrequencyMetric

NewFrequencyMetric will return a new metric with instantiated maps

func (*FrequencyMetric) CountSample

func (m *FrequencyMetric) CountSample(k string)

CountSample will add all frequencies in the metric. If rhs is nil, we will return immediately with no error. We will treat nil as zero count.

type FrequencyMetrics

type FrequencyMetrics map[string]FrequencyMetric

FrequencyMetrics is a collection of metrics

type Metric

type Metric interface {
	GetFrequencyMetrics() []FrequencyMetric
	GetSEHMetrics() []SEHMetric
	GetTimestamp() time.Time
	GetKeys() map[string]string
	GetSamples() []map[string]interface{}
}

Metric interface that is used to retrieve the necessary data to construct a PutRecord call to the voxdataplane service.

type SEHMetric

type SEHMetric struct {
	Name    string
	Stats   StatisticSet
	Buckets map[int64]float64
}

Type for a metric backed by a sparse exponential histogram (Seh) distribution

func NewSEHMetric

func NewSEHMetric(name string) SEHMetric

NewSEHMetric creates a new metric with an empty distribution

func (*SEHMetric) AddSample

func (m *SEHMetric) AddSample(value float64) error

AddSample will add a sample to an SEH metric. The zero bucket is specified to be -32768 which should not be hit by math.Log call.

func (*SEHMetric) AddWeightedSample

func (m *SEHMetric) AddWeightedSample(v float64, weight float64) error

type SEHMetrics

type SEHMetrics map[string]SEHMetric

SEHMetrics is a collection of metrics

type StatisticSet

type StatisticSet struct {
	SampleCount float64
	Sum         float64
	Min         float64
	Max         float64
}

func NewStatisticSet

func NewStatisticSet(value float64) StatisticSet

func NewWeightedStatisticSet

func NewWeightedStatisticSet(value float64, weight float64) StatisticSet

func (*StatisticSet) Merge

func (this *StatisticSet) Merge(other StatisticSet) error

Merges two statistic set distributions

Based on the following assumptions about IEEE fp math/representations:

(1) All finite floating point numbers are exactly one of == 0, < 0, or > 0
(2) Adding a (representable) positive number to a non-negative number results in a positive number

we can use a SampleCount of 0 as a marker for an empty distribution since we only allow the merging of non-negative sample counts