ilog

Documentation

Overview

ilog is a simple logging interface library package for Go. By defining only the logger interface `ilog.Logger`, users can easily swap out the underlying logging implementation without changing their application code.

Index

• Variables
• func NewBuilder(level Level, w io.Writer) implLoggerConfig
• func NewSyncWriter(w io.Writer) io.Writer
• func SetGlobal(logger Logger) (rollback func())
• func SetStdLogger(l Logger) (rollback func())
• func WithContext(ctx context.Context, logger Logger) context.Context
• type Level
• type LogEntry
• type Logger
  • func FromContext(ctx context.Context) (logger Logger)
  • func Global() Logger
  • func L() Logger

Variables

var ErrLogEntryIsNotWritten = errors.New("ilog: log entry not written")

ErrLogEntryIsNotWritten is the error returned when a log entry is not written.

Functions

func NewBuilder

func NewBuilder(level Level, w io.Writer) implLoggerConfig

NewBuilder returns a new Builder of ilog.Logger with the specified level and writer.

func NewSyncWriter

func NewSyncWriter(w io.Writer) io.Writer

func SetGlobal

func SetGlobal(logger Logger) (rollback func())

func SetStdLogger

func SetStdLogger(l Logger) (rollback func())

func WithContext

func WithContext(ctx context.Context, logger Logger) context.Context

Types

type Level

type Level int8

Level is the type for logging level.

const (
	DebugLevel Level = -8
	InfoLevel  Level = 0
	WarnLevel  Level = 8
	ErrorLevel Level = 16
)

type LogEntry

type LogEntry interface {

	// Logger returns a new logger with the same fields of the log entry.
	Logger() (copied Logger)

	// error: for considering undispatched LogEntry as error so that they can be detected by Go static analysis.
	error
	// contains filtered or unexported methods
}

LogEntry is the interface that has the logging methods for a single log entry.

type Logger

type Logger interface {
	// Level returns the current logging level of the logger.
	Level() (currentLoggerLevel Level)
	// SetLevel sets the logging level of the logger.
	SetLevel(level Level) (copied Logger)
	// AddCallerSkip adds the number of stack frames to skip to the logger.
	AddCallerSkip(skip int) (copied Logger)
	// Copy returns a copy of the logger.
	Copy() (copied Logger)
	// contains filtered or unexported methods
}

Logger is the interface that has the basic logging methods.

func FromContext

func FromContext(ctx context.Context) (logger Logger)

func Global

func Global() Logger

func L

func L() Logger