trace

Documentation

Overview

Package trace provides simple interfaces for timing applications

Index

• func Enabled(e bool)
• func Enter()
• func Exit()
• func GetTag() string
• func IsEnabled() bool
• func SetLogger(l Logger)
• func SetTag(t string)
• type HCLog
  • func NewHCLog(logger hclog.Logger, level hclog.Level) HCLog
  • func (l HCLog) Print(args ...interface{})
• type Logger
  • func GetLogger() Logger
• type Timer
  • func Start(name string) *Timer
  • func (t *Timer) Since(args ...interface{})

Functions

func Enabled

func Enabled(e bool)

func Enter

func Enter()

func Exit

func Exit()

func GetTag

func GetTag() string

func IsEnabled

func IsEnabled() bool

func SetLogger

func SetLogger(l Logger)

func SetTag

func SetTag(t string)

Types

type HCLog

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

HCLog is a Logger that uses the go-hclog log package to output timer information.

func NewHCLog

func NewHCLog(logger hclog.Logger, level hclog.Level) HCLog

func (HCLog) Print

func (l HCLog) Print(args ...interface{})

Print writes timer information using the logger's Log function, with the configured level.

type Logger

type Logger interface {
	Print(args ...interface{})
}

func GetLogger

func GetLogger() Logger

type Timer

type Timer struct {
	Tag string
	Log Logger
	// contains filtered or unexported fields
}

func Start

func Start(name string) *Timer

Start a timer with the specified name.

func (*Timer) Since

func (t *Timer) Since(args ...interface{})

Since logs the time since the timer started. If present the optional args will be appended to the message.