log

Documentation

Overview

Package log provides leveled logging interface. The log messages are intended to be user-facing similar to the standard library's log package.

Index

• Variables
• type Level
  • func (l Level) String() string
• type Logger
  • func New(w io.Writer) *Logger
  • func (l *Logger) Debugf(msg string, args ...interface{})
  • func (l *Logger) Errorf(msg string, args ...interface{})
  • func (l *Logger) Infof(msg string, args ...interface{})
  • func (l *Logger) Level() Level
  • func (l *Logger) Log(level Level, msg string, args ...interface{})
  • func (l *Logger) WithLevel(lvl Level) *Logger
  • func (l *Logger) WithName(name string) *Logger
• type Writer
  • func (w *Writer) Close() error
  • func (w *Writer) Write(bs []byte) (int, error)

Variables

var Discard = New(io.Discard).WithLevel(discard)

Discard is a logger that discards all its operations.

Types

type Level

type Level int

Level specifies the level of logging.

const (
	Debug Level = iota - 1
	Info
	Error
)

Supported log levels.

func (Level) String

func (l Level) String() string

type Logger

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

Logger is a thread-safe logger safe for concurrent use.

func New

func New(w io.Writer) *Logger

New builds a logger that writes to the given writer. The logger defaults to level Info.

func (*Logger) Debugf

func (l *Logger) Debugf(msg string, args ...interface{})

Debugf logs messages at the debug level.

func (*Logger) Errorf

func (l *Logger) Errorf(msg string, args ...interface{})

Errorf logs messages at the error level.

func (*Logger) Infof

func (l *Logger) Infof(msg string, args ...interface{})

Infof logs messages at the info level.

func (*Logger) Level

func (l *Logger) Level() Level

Level reports the level of the logger. The logger will only log messages of this level or higher.

func (*Logger) Log

func (l *Logger) Log(level Level, msg string, args ...interface{})

Log logs messages at the provided level.

func (*Logger) WithLevel

func (l *Logger) WithLevel(lvl Level) *Logger

WithLevel buils a new logger that will log messages of the given level or higher. The returned logger is safe to use concurrently with this logger.

func (*Logger) WithName

func (l *Logger) WithName(name string) *Logger

WithName builds a new logger with the provided name. The returned logger is safe to use concurrently with this logger.

type Writer

type Writer struct {
	Log   *Logger
	Level Level
	// contains filtered or unexported fields
}

Writer is an io.Writer that writes to the provided logger, splitting messages across newlines into new log entries.

func (*Writer) Close

func (w *Writer) Close() error

Close closes the Writer, flushing any buffered data to the underlying log.

func (*Writer) Write

func (w *Writer) Write(bs []byte) (int, error)