logger

Documentation

Index

• Variables
• func RotateShared() error
• type Logger
  • func NewLogger(cfg config.Log) (Logger, error)
  • func NewLoggerWriter(cfg config.Log, out io.Writer) (Logger, error)
• type LoggerDelegator
  • func (l *LoggerDelegator) Close() error
  • func (l *LoggerDelegator) LogLogger() *log.Logger
  • func (l *LoggerDelegator) Printf(format string, args ...interface{})
  • func (l *LoggerDelegator) Rotate() error
  • func (l *LoggerDelegator) Write(p []byte) (int, error)
• type NopRotator
  • func (*NopRotator) Close() error
  • func (*NopRotator) Rotate() error
• type Rotator
  • func NewRotator(output string, cfg config.Rotation) (Rotator, error)
  • func SharedRotator(output string, cfg config.Rotation) (Rotator, error)

Variables

var (
	NilLogLogger = log.New(io.Discard, "", 0)
	NilLogger    nilLogger
)

var (
	NilRotator = &NopRotator{Writer: io.Discard}
)

Functions

func RotateShared

func RotateShared() error

RotateShared calls Rotate each shared rotators.

Types

type Logger

type Logger interface {
	fasthttp.Logger
	Rotator
	io.Closer
	LogLogger() *log.Logger
}

Logger is the interface that defines the methods to logging.

func NewLogger

func NewLogger(cfg config.Log) (Logger, error)

NewLogger creates a new logger.

func NewLoggerWriter

func NewLoggerWriter(cfg config.Log, out io.Writer) (Logger, error)

NewLoggerWriter returns a new logger with out.

type LoggerDelegator

type LoggerDelegator struct {
	PrintfFunc    func(format string, args ...interface{})
	RotateFunc    func() error
	WriteFunc     func([]byte) (int, error)
	CloseFunc     func() error
	LogLoggerFunc func() *log.Logger
}

LoggerDelegator can delegate the Logger functions.

func (*LoggerDelegator) Close

func (l *LoggerDelegator) Close() error

func (*LoggerDelegator) LogLogger

func (l *LoggerDelegator) LogLogger() *log.Logger

func (*LoggerDelegator) Printf

func (l *LoggerDelegator) Printf(format string, args ...interface{})

func (*LoggerDelegator) Rotate

func (l *LoggerDelegator) Rotate() error

func (*LoggerDelegator) Write

func (l *LoggerDelegator) Write(p []byte) (int, error)

type NopRotator

type NopRotator struct {
	io.Writer
}

NopRotator is a Writer with no-op Rotate and Close methods.

func (*NopRotator) Close

func (*NopRotator) Close() error

Close does nothing, returns nil.

func (*NopRotator) Rotate

func (*NopRotator) Rotate() error

Rotate does nothing, returns nil.

type Rotator

type Rotator interface {
	io.WriteCloser
	Rotate() error
}

Rotator is the interface that groups the Rotate and basic Write, Close methods.

func NewRotator

func NewRotator(output string, cfg config.Rotation) (Rotator, error)

NewRotator creates a new rotator.

func SharedRotator

func SharedRotator(output string, cfg config.Rotation) (Rotator, error)

SharedRotator returns a Rotator that is mapped by output. If the Rotator mapped by output does not exist, a new Rotator is created. If there are duplicate ouput, the backward cfg is ignored.