chanstats

Documentation

Index

• type ChanStats
  • func New() *ChanStats
• type Details
  • func NewDetails(m *Messages) *Details
• type Messages
• type Report
  • func NewReport(s *ChanStats) *Report
• type WelfordStats
  • func NewWelford(w *welford.Stats) *WelfordStats

Types

type ChanStats

type ChanStats struct {
	ConnectedAt time.Time
	Rx          Messages
	Tx          Messages
}

ChanStats represents recorded channel statistics

func New

func New() *ChanStats

New returns a pointer to new ChanStats struct with statistics initialised

type Details

type Details struct {
	Last  string       `json:"last"` //how many seconds ago...
	Bytes WelfordStats `json:"bytes"`
	Dt    WelfordStats `json:"dt"`
}

Details represents detailed statistics

func NewDetails

func NewDetails(m *Messages) *Details

NewDetails holds detailed information on channel statistics in one direction

type Messages

type Messages struct {
	Last  time.Time
	Bytes *welford.Stats
	Dt    *welford.Stats
}

Messages represents statistics for messages

type Report

type Report struct {
	Connected string  `json:"connected"`
	Tx        Details `json:"tx"`
	Rx        Details `json:"rx"`
}

Report represents overally statistics for a topic

func NewReport

func NewReport(s *ChanStats) *Report

NewReport represents a new report on channel statistics

type WelfordStats

type WelfordStats struct {
	Count    uint64  `json:"count"`
	Min      float64 `json:"min"`
	Max      float64 `json:"max"`
	Mean     float64 `json:"mean"`
	Stddev   float64 `json:"stddev"`
	Variance float64 `json:"variance"`
}

WelfordStats represents statistical values

func NewWelford

func NewWelford(w *welford.Stats) *WelfordStats

NewWelford initialises a new statistics structure