measure

README

Stopwatch

A simple utility able to log measured time periods of various events. To create a new stopwatch, call:

sw := NewStopwatch(name string, log logging.Logger)

Stopwatch object can store a new entry with sw.LogTimeEntry(n interface{}, d time.Duration) where n is a string representation of a measured entity (name of a function, struct or just simple string) and d is time duration. If the name already exists, it will be indexed (for example name#1)

Use sw.Print() to print all measurements and clear stored entries.

Documentation

Index

• type StopWatchEntry
• type Stopwatch
  • func NewStopwatch(name string, log logging.Logger) *Stopwatch
  • func (st *Stopwatch) LogTimeEntryFor(n interface{}) func()
  • func (st *Stopwatch) PrintLog()
  • func (st *Stopwatch) TimeLog(n interface{}) *TimeLog
• type TimeLog
  • func GetTimeLog(n interface{}, s *Stopwatch) *TimeLog
  • func (t *TimeLog) LogTimeEntry(d time.Duration)

Types

type StopWatchEntry

type StopWatchEntry interface {
	LogTimeEntry(d time.Duration)
}

StopWatchEntry provides method to log measured time entries

type Stopwatch

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

Stopwatch keeps all time measurement results

func NewStopwatch

func NewStopwatch(name string, log logging.Logger) *Stopwatch

NewStopwatch creates a new stopwatch object with empty time map

func (*Stopwatch) LogTimeEntryFor

func (st *Stopwatch) LogTimeEntryFor(n interface{}) func()

LogTimeEntryFor sets start time and returns func which logs the time entry, usable as single-line defer call: `defer s.LogTimeEntryFor("xyz")()`

func (*Stopwatch) PrintLog

func (st *Stopwatch) PrintLog()

PrintLog all entries from TimeLog and reset it

func (*Stopwatch) TimeLog

func (st *Stopwatch) TimeLog(n interface{}) *TimeLog

TimeLog returns a pointer to the TimeLog object related to the provided name (derived from the <n> parameter). If stopwatch instance is nil, returns nil

type TimeLog

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

TimeLog is a wrapper for the measured data for specific name

func GetTimeLog

func GetTimeLog(n interface{}, s *Stopwatch) *TimeLog

GetTimeLog returns a pointer to the TimeLog object related to the provided name (derived from the <n> parameter). If stopwatch is not used, returns nil

func (*TimeLog) LogTimeEntry

func (t *TimeLog) LogTimeEntry(d time.Duration)

LogTimeEntry stores time entry to the TimeLog (the time log itself is stored in the stopwatch sync.Map)