metrics

Documentation

Index

• type Metrics
  • func NewMetrics(tickerInterval time.Duration) *Metrics
  • func (m *Metrics) AddBits(bits uint64)
  • func (m *Metrics) AddError(count uint64)
  • func (m *Metrics) AddPacket(count uint64)
  • func (m *Metrics) AddSample(sample uint64)
  • func (m *Metrics) GetAvgDepth() uint64
  • func (m *Metrics) GetBitRate() uint64
  • func (m *Metrics) GetErrorRate() uint64
  • func (m *Metrics) GetPacketRate() uint64
  • func (m *Metrics) Stop()

Types

type Metrics

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

func NewMetrics

func NewMetrics(tickerInterval time.Duration) *Metrics

NewMetrics creates a new Metrics instance and starts a goroutine to update bitRate, packetRate, errorRate, and avgDepth every interval.

func (*Metrics) AddBits

func (m *Metrics) AddBits(bits uint64)

AddBits increments the bit counter by the specified amount

func (*Metrics) AddError

func (m *Metrics) AddError(count uint64)

AddError increments the error counter by the specified amount

func (*Metrics) AddPacket

func (m *Metrics) AddPacket(count uint64)

AddPacket increments the packet counter by the specified amount

func (*Metrics) AddSample

func (m *Metrics) AddSample(sample uint64)

AddSample adds a depth sample to be averaged

func (*Metrics) GetAvgDepth

func (m *Metrics) GetAvgDepth() uint64

GetAvgDepth returns the current average depth

func (*Metrics) GetBitRate

func (m *Metrics) GetBitRate() uint64

GetBitRate returns the current bits per second rate

func (*Metrics) GetErrorRate

func (m *Metrics) GetErrorRate() uint64

GetErrorRate returns the current errors per second rate

func (*Metrics) GetPacketRate

func (m *Metrics) GetPacketRate() uint64

GetPacketRate returns the current packets per second rate

func (*Metrics) Stop

func (m *Metrics) Stop()

Stop gracefully stops the goroutine by canceling the context