log

Documentation

Overview

Package log exports logging related types and functions.

Index

• type Base
• type Level
  • func (l Level) String() string
• type Logger
  • func NewLogger(base Base) *Logger
  • func (l *Logger) Debug(args ...any)
  • func (l *Logger) Debugf(format string, args ...any)
  • func (l *Logger) Error(args ...any)
  • func (l *Logger) Errorf(format string, args ...any)
  • func (l *Logger) Fatal(args ...any)
  • func (l *Logger) Fatalf(format string, args ...any)
  • func (l *Logger) Info(args ...any)
  • func (l *Logger) Infof(format string, args ...any)
  • func (l *Logger) SetLevel(v Level)
  • func (l *Logger) Warn(args ...any)
  • func (l *Logger) Warnf(format string, args ...any)

Types

type Base

type Base interface {
	// Debug logs a message at Debug level.
	Debug(args ...any)

	// Info logs a message at Info level.
	Info(args ...any)

	// Warn logs a message at Warning level.
	Warn(args ...any)

	// Error logs a message at Error level.
	Error(args ...any)

	// Fatal logs a message at Fatal level
	// and process will exit with status set to 1.
	Fatal(args ...any)
}

Base supports logging at various log levels.

type Level

type Level int32

Level represents a log level.

const (
	// DebugLevel is the lowest level of logging.
	// Debug logs are intended for debugging and development purposes.
	DebugLevel Level = iota

	// InfoLevel is used for general informational log messages.
	InfoLevel

	// WarnLevel is used for undesired but relatively expected events,
	// which may indicate a problem.
	WarnLevel

	// ErrorLevel is used for undesired and unexpected events that
	// the program can recover from.
	ErrorLevel

	// FatalLevel is used for undesired and unexpected events that
	// the program cannot recover from.
	FatalLevel
)

func (Level) String

func (l Level) String() string

String is part of the fmt.Stringer interface.

Used for testing and debugging purposes.

type Logger

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

Logger logs message to io.Writer at various log levels.

func NewLogger

func NewLogger(base Base) *Logger

NewLogger creates and returns a new instance of Logger. Log level is set to DebugLevel by default.

func (*Logger) Debug

func (l *Logger) Debug(args ...any)

func (*Logger) Debugf

func (l *Logger) Debugf(format string, args ...any)

func (*Logger) Error

func (l *Logger) Error(args ...any)

func (*Logger) Errorf

func (l *Logger) Errorf(format string, args ...any)

func (*Logger) Fatal

func (l *Logger) Fatal(args ...any)

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, args ...any)

func (*Logger) Info

func (l *Logger) Info(args ...any)

func (*Logger) Infof

func (l *Logger) Infof(format string, args ...any)

func (*Logger) SetLevel

func (l *Logger) SetLevel(v Level)

SetLevel sets the logger level. It panics if v is less than DebugLevel or greater than FatalLevel.

func (*Logger) Warn

func (l *Logger) Warn(args ...any)

func (*Logger) Warnf

func (l *Logger) Warnf(format string, args ...any)