logger

Documentation

Index

• func Errorf(format string, args ...any)
• func ErrorfSkipframes(skipframes int, format string, args ...any)
• func Fatalf(format string, args ...any)
• func Infof(format string, args ...any)
• func Init()
• func InitNoLogFlags()
• func Panicf(format string, args ...any)
• func ResetOutputForTest()
• func SetOutputForTests(writer io.Writer)
• func StdErrorLogger() *log.Logger
• func Warnf(format string, args ...any)
• func WarnfSkipframes(skipframes int, format string, args ...any)
• type LogThrottler
  • func WithThrottler(name string, throttle time.Duration) *LogThrottler
  • func (lt *LogThrottler) Errorf(format string, args ...any)
  • func (lt *LogThrottler) Warnf(format string, args ...any)

Functions

func Errorf

func Errorf(format string, args ...any)

Errorf logs error message.

func ErrorfSkipframes

func ErrorfSkipframes(skipframes int, format string, args ...any)

ErrorfSkipframes logs error message and skips the given number of frames for the caller.

func Fatalf

func Fatalf(format string, args ...any)

Fatalf logs fatal message and terminates the app.

func Infof

func Infof(format string, args ...any)

Infof logs info message.

func Init

func Init()

Init initializes the logger.

Init must be called after flag.Parse()

There is no need in calling Init from tests.

func InitNoLogFlags

func InitNoLogFlags()

InitNoLogFlags initializes the logger without writing flags to stdout

InitNoLogFlags must be called after flag.Parse()

func Panicf

func Panicf(format string, args ...any)

Panicf logs panic message and panics.

func ResetOutputForTest

func ResetOutputForTest()

ResetOutputForTest set logger output to default value

func SetOutputForTests

func SetOutputForTests(writer io.Writer)

SetOutputForTests redefine output for logger. Use for Tests only. Call ResetOutputForTest to return output state to default

func StdErrorLogger

func StdErrorLogger() *log.Logger

StdErrorLogger returns standard error logger.

func Warnf

func Warnf(format string, args ...any)

Warnf logs warn message.

func WarnfSkipframes

func WarnfSkipframes(skipframes int, format string, args ...any)

WarnfSkipframes logs warn message and skips the given number of frames for the caller.

Types

type LogThrottler

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

LogThrottler is a logger, which throttles log messages passed to Warnf and Errorf.

LogThrottler must be created via WithThrottler() call.

func WithThrottler

func WithThrottler(name string, throttle time.Duration) *LogThrottler

WithThrottler returns a logger throttled by time - only one message in throttle duration will be logged.

New logger is created only once for each unique name passed. The function is thread-safe.

func (*LogThrottler) Errorf

func (lt *LogThrottler) Errorf(format string, args ...any)

Errorf logs error message.

func (*LogThrottler) Warnf

func (lt *LogThrottler) Warnf(format string, args ...any)

Warnf logs warn message.