log

Documentation

Index

• Variables
• type Level
  • func (l Level) String() string
• type Log
  • func New(level Level, writers ...io.Writer) *Log
  • func (l *Log) Debug(v ...any)
  • func (l *Log) Debugf(format string, v ...any)
  • func (l *Log) Error(v ...any)
  • func (l *Log) Errorf(format string, v ...any)
  • func (l *Log) Fatal(v ...any)
  • func (l *Log) Fatalf(format string, v ...any)
  • func (l *Log) Info(v ...any)
  • func (l *Log) Infof(format string, v ...any)
  • func (l *Log) LogLevel() Level
  • func (l *Log) LogOutput() []io.Writer
  • func (l *Log) Panic(v ...any)
  • func (l *Log) Panicf(format string, v ...any)
  • func (l *Log) StdLogger() *golog.Logger
  • func (l *Log) Warn(v ...any)
  • func (l *Log) Warnf(format string, v ...any)
• type Logger

Variables

var DefaultLogger = New(DebugLevel, os.Stdout)

DefaultLogger represents the default Log to use This Log wraps zap under the hood

var DiscardLogger = New(DebugLevel, io.Discard)

Types

type Level

type Level int

Level specifies the log level

const (
	// InfoLevel indicates Info log level.
	InfoLevel Level = iota
	// WarningLevel indicates Warning log level.
	WarningLevel
	// ErrorLevel indicates Error log level.
	ErrorLevel
	// FatalLevel indicates Fatal log level.
	FatalLevel
	// PanicLevel indicates Panic log level
	PanicLevel
	// DebugLevel indicates Debug log level
	DebugLevel
	InvalidLevel
)

func (Level) String

func (l Level) String() string

String returns the string representation of the level

type Log

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

Log implements Logger interface with the underlying zap as the underlying logging library

func New

func New(level Level, writers ...io.Writer) *Log

New creates an instance of Log New creates an instance of Log

func (*Log) Debug

func (l *Log) Debug(v ...any)

Debug starts a message with debug level

func (*Log) Debugf

func (l *Log) Debugf(format string, v ...any)

Debugf starts a message with debug level

func (*Log) Error

func (l *Log) Error(v ...any)

Error starts a new message with error level.

func (*Log) Errorf

func (l *Log) Errorf(format string, v ...any)

Errorf starts a new message with error level.

func (*Log) Fatal

func (l *Log) Fatal(v ...any)

Fatal starts a new message with fatal level. The os.Exit(1) function is called which terminates the program immediately.

func (*Log) Fatalf

func (l *Log) Fatalf(format string, v ...any)

Fatalf starts a new message with fatal level. The os.Exit(1) function is called which terminates the program immediately.

func (*Log) Info

func (l *Log) Info(v ...any)

Info starts a message with info level

func (*Log) Infof

func (l *Log) Infof(format string, v ...any)

Infof starts a message with info level

func (*Log) LogLevel

func (l *Log) LogLevel() Level

LogLevel returns the log level that is used

func (*Log) LogOutput

func (l *Log) LogOutput() []io.Writer

LogOutput returns the log output that is set

func (*Log) Panic

func (l *Log) Panic(v ...any)

Panic starts a new message with panic level. The panic() function is called which stops the ordinary flow of a goroutine.

func (*Log) Panicf

func (l *Log) Panicf(format string, v ...any)

Panicf starts a new message with panic level. The panic() function is called which stops the ordinary flow of a goroutine.

func (*Log) StdLogger

func (l *Log) StdLogger() *golog.Logger

StdLogger returns the standard logger associated to the logger

func (*Log) Warn

func (l *Log) Warn(v ...any)

Warn starts a new message with warn level

func (*Log) Warnf

func (l *Log) Warnf(format string, v ...any)

Warnf starts a new message with warn level

type Logger

type Logger interface {
	// Info starts a new message with info level.
	Info(...any)
	// Infof starts a new message with info level.
	Infof(string, ...any)
	// Warn starts a new message with warn level.
	Warn(...any)
	// Warnf starts a new message with warn level.
	Warnf(string, ...any)
	// Error starts a new message with error level.
	Error(...any)
	// Errorf starts a new message with error level.
	Errorf(string, ...any)
	// Fatal starts a new message with fatal level. The os.Exit(1) function
	// is called which terminates the program immediately.
	Fatal(...any)
	// Fatalf starts a new message with fatal level. The os.Exit(1) function
	// is called which terminates the program immediately.
	Fatalf(string, ...any)
	// Panic starts a new message with panic level. The panic() function
	// is called which stops the ordinary flow of a goroutine.
	Panic(...any)
	// Panicf starts a new message with panic level. The panic() function
	// is called which stops the ordinary flow of a goroutine.
	Panicf(string, ...any)
	// Debug starts a new message with debug level.
	Debug(...any)
	// Debugf starts a new message with debug level.
	Debugf(string, ...any)
	// LogLevel returns the log level being used
	LogLevel() Level
	// LogOutput returns the log output that is set
	LogOutput() []io.Writer
	// StdLogger returns the standard logger associated to the logger
	StdLogger() *golog.Logger
}

Logger represents an active logging object that generates lines of output to an io.Writer.