summarymetrics

Documentation

Overview

Package summarymetrics provides a summary metric implementation

Index

• type SummaryMetric
  • func EmptySummaryMetric() *SummaryMetric
  • func (m *SummaryMetric) Add(value float64) *SummaryMetric
  • func (m *SummaryMetric) Count() uint32
  • func (m *SummaryMetric) Max() float64
  • func (m *SummaryMetric) Min() float64
  • func (m *SummaryMetric) SetCount(v uint32)
  • func (m *SummaryMetric) SetMax(v float64)
  • func (m *SummaryMetric) SetMin(v float64)
  • func (m *SummaryMetric) SetSum(v float64)
  • func (m *SummaryMetric) SetSumSquares(v float64)
  • func (m *SummaryMetric) String() string
  • func (m *SummaryMetric) Sum() float64
  • func (m *SummaryMetric) SumSquares() float64

Types

type SummaryMetric

type SummaryMetric [5]float64

SummaryMetric is summary metric type

func EmptySummaryMetric

func EmptySummaryMetric() *SummaryMetric

EmptySummaryMetric returns metric object without any values added

func (*SummaryMetric) Add

func (m *SummaryMetric) Add(value float64) *SummaryMetric

Add adds an observed value to the metric

func (*SummaryMetric) Count

func (m *SummaryMetric) Count() uint32

Count returns the number of observed values summarized by the metric

func (*SummaryMetric) Max

func (m *SummaryMetric) Max() float64

Max is the maximum of the observed values

func (*SummaryMetric) Min

func (m *SummaryMetric) Min() float64

Min is the minimum of the observed values

func (*SummaryMetric) SetCount

func (m *SummaryMetric) SetCount(v uint32)

SetCount sets the number of observed values summarized by the metric

func (*SummaryMetric) SetMax

func (m *SummaryMetric) SetMax(v float64)

SetMax sets the maximum of the observed values

func (*SummaryMetric) SetMin

func (m *SummaryMetric) SetMin(v float64)

SetMin sets the minimum of the observed values

func (*SummaryMetric) SetSum

func (m *SummaryMetric) SetSum(v float64)

SetSum sets the sum of the observed values

func (*SummaryMetric) SetSumSquares

func (m *SummaryMetric) SetSumSquares(v float64)

SetSumSquares sets the sum of the squares of the observed values

func (*SummaryMetric) String

func (m *SummaryMetric) String() string

String returns a string representing the metric (not all fields are included)

func (*SummaryMetric) Sum

func (m *SummaryMetric) Sum() float64

Sum is the sum of the observed values

func (*SummaryMetric) SumSquares

func (m *SummaryMetric) SumSquares() float64

SumSquares is the sum of the squares of the observed values