prometheustimer

Documentation

Index

• type StopWatch
  • func (sw *StopWatch) End()
  • func (sw *StopWatch) Record()
  • func (sw *StopWatch) Reset()
  • func (sw *StopWatch) Start()
• type Timer
  • func (timer *Timer) End()
• type TimerFactory
  • func New(name, tip string, labelNames []string, defaultLabels []string) (*TimerFactory, error)
  • func (factory *TimerFactory) NewStopWatch(labels ...string) *StopWatch
  • func (factory *TimerFactory) NewTimer(labels ...string) *Timer

Types

type StopWatch

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

StopWatch is used to measure accumulation of multiple time slices.

func (*StopWatch) End

func (sw *StopWatch) End()

End ends the StopWatch and log the total accumulated time.

func (*StopWatch) Record

func (sw *StopWatch) Record()

Record records time between start time to now into accumulated time.

func (*StopWatch) Reset

func (sw *StopWatch) Reset()

Reset cleans out the accumulated time.

func (*StopWatch) Start

func (sw *StopWatch) Start()

Start reset start time to now.

type Timer

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

Timer defines a timer to measure performance

func (*Timer) End

func (timer *Timer) End()

End ends the timer

type TimerFactory

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

TimerFactory defines a timer factory to generate timer

func New

func New(name, tip string, labelNames []string, defaultLabels []string) (*TimerFactory, error)

New returns a new Timer

func (*TimerFactory) NewStopWatch

func (factory *TimerFactory) NewStopWatch(labels ...string) *StopWatch

NewStopWatch returns a StopWatch with start time as now

func (*TimerFactory) NewTimer

func (factory *TimerFactory) NewTimer(labels ...string) *Timer

NewTimer returns a timer with start time as now