logger

Documentation

Overview

Package logger provides a simple leveled logging implementation for CLI tools.

Index

• Variables
• func Debug(args ...any)
• func Debugf(format string, args ...any)
• func Error(args ...any)
• func Errorf(format string, args ...any)
• func Fatal(args ...any)
• func Fatalf(format string, args ...any)
• func Info(args ...any)
• func Infof(format string, args ...any)
• func SetMaxLevel(level Level)
• func SetOutput(w io.Writer)
• func Verbose(args ...any)
• func Verbosef(format string, args ...any)
• func Warn(args ...any)
• func Warnf(format string, args ...any)
• type Level
  • func GetMaxLevel() Level
  • func (l Level) String() string
• type Logger
  • func New(maxLevel Level, output io.Writer) *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) GetMaxLevel() Level
  • func (l *Logger) Info(args ...any)
  • func (l *Logger) Infof(format string, args ...any)
  • func (l *Logger) SetMaxLevel(level Level)
  • func (l *Logger) SetOutput(w io.Writer)
  • func (l *Logger) Verbose(args ...any)
  • func (l *Logger) Verbosef(format string, args ...any)
  • func (l *Logger) Warn(args ...any)
  • func (l *Logger) Warnf(format string, args ...any)

Variables

var DefaultLogger = New(LevelInfo, os.Stderr)

DefaultLogger is the global logger instance used by package-level functions.

Functions

func Debug

func Debug(args ...any)

Debug logs a message at Debug level using the DefaultLogger.

func Debugf

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

Debugf logs a formatted message at Debug level using the DefaultLogger.

func Error

func Error(args ...any)

Error logs a message at Error level using the DefaultLogger.

func Errorf

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

Errorf logs a formatted message at Error level using the DefaultLogger.

func Fatal

func Fatal(args ...any)

Fatal logs a message at Fatal level using the DefaultLogger and exits.

func Fatalf

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

Fatalf logs a formatted message at Fatal level using the DefaultLogger and exits.

func Info

func Info(args ...any)

Info logs a message at Info level using the DefaultLogger.

func Infof

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

Infof logs a formatted message at Info level using the DefaultLogger.

func SetMaxLevel

func SetMaxLevel(level Level)

SetMaxLevel sets the maximum logging level on the DefaultLogger.

func SetOutput

func SetOutput(w io.Writer)

SetOutput sets the output destination for the DefaultLogger.

func Verbose

func Verbose(args ...any)

Verbose logs a message at Verbose level using the DefaultLogger.

func Verbosef

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

Verbosef logs a formatted message at Verbose level using the DefaultLogger.

func Warn

func Warn(args ...any)

Warn logs a message at Warning level using the DefaultLogger.

func Warnf

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

Warnf logs a formatted message at Warning level using the DefaultLogger.

Types

type Level

type Level int

Level represents the severity of a log message.

const (
	LevelFatal Level = iota
	LevelError
	LevelWarning
	LevelInfo
	LevelDebug
	LevelVerbose
)

func GetMaxLevel

func GetMaxLevel() Level

GetMaxLevel returns the current maximum logging level from the DefaultLogger.

func (Level) String

func (l Level) String() string

String returns the string representation of a Level.

type Logger

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

Logger is a leveled logger that outputs messages with level prefixes.

func New

func New(maxLevel Level, output io.Writer) *Logger

New creates a new Logger with the specified max level and output writer.

func (*Logger) Debug

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

Debug logs a message at Debug level.

func (*Logger) Debugf

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

Debugf logs a formatted message at Debug level.

func (*Logger) Error

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

Error logs a message at Error level.

func (*Logger) Errorf

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

Errorf logs a formatted message at Error level.

func (*Logger) Fatal

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

Fatal logs a message at Fatal level and exits the program.

func (*Logger) Fatalf

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

Fatalf logs a formatted message at Fatal level and exits the program.

func (*Logger) GetMaxLevel

func (l *Logger) GetMaxLevel() Level

GetMaxLevel returns the current maximum logging level.

func (*Logger) Info

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

Info logs a message at Info level.

func (*Logger) Infof

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

Infof logs a formatted message at Info level.

func (*Logger) SetMaxLevel

func (l *Logger) SetMaxLevel(level Level)

SetMaxLevel sets the maximum logging level. Messages with a level higher than maxLevel will not be logged.

func (*Logger) SetOutput

func (l *Logger) SetOutput(w io.Writer)

SetOutput sets the output destination for the logger.

func (*Logger) Verbose

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

Verbose logs a message at Verbose level.

func (*Logger) Verbosef

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

Verbosef logs a formatted message at Verbose level.

func (*Logger) Warn

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

Warn logs a message at Warning level.

func (*Logger) Warnf

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

Warnf logs a formatted message at Warning level.