log

Documentation

Overview

Package log provides a logging backend, based around the go-logging package.

Index

• type Backend
  • func New(f string, level string, disable bool) (*Backend, error)
  • func (b *Backend) GetGoLogger(module string, level string) *goLog.Logger
  • func (b *Backend) GetLevel(level string) logging.Level
  • func (b *Backend) GetLogWriter(module string, level string) io.Writer
  • func (b *Backend) GetLogger(module string) *logging.Logger
  • func (b *Backend) IsEnabledFor(level logging.Level, module string) bool
  • func (b *Backend) Log(level logging.Level, calldepth int, record *logging.Record) error
  • func (b *Backend) Rotate() error
  • func (b *Backend) SetLevel(level logging.Level, module string)

Types

type Backend

type Backend struct {
	logging.LeveledBackend
	sync.RWMutex
	// contains filtered or unexported fields
}

Backend is a log backend.

func New

func New(f string, level string, disable bool) (*Backend, error)

New initializes a logging backend.

func (*Backend) GetGoLogger

func (b *Backend) GetGoLogger(module string, level string) *goLog.Logger

GetGoLogger returns a per-module Go runtime *log.Logger that writes to the backend. Due to limitations of the Go runtime log package, only one level is supported per returned Logger.

func (*Backend) GetLevel

func (b *Backend) GetLevel(level string) logging.Level

GetLevel returns the logging level for the specified module as per the logging.Leveled interface.

func (*Backend) GetLogWriter

func (b *Backend) GetLogWriter(module string, level string) io.Writer

GetLogWriter returns a per-module io.Writer that writes to the backend at the provided level.

func (*Backend) GetLogger

func (b *Backend) GetLogger(module string) *logging.Logger

GetLogger returns a per-module logger that writes to the backend.

func (*Backend) IsEnabledFor

func (b *Backend) IsEnabledFor(level logging.Level, module string) bool

IsEnabledFor returns true if the logger is enabled for the given level. We use this function as part of our implementation of the logging.Leveled interface.

func (*Backend) Log

func (b *Backend) Log(level logging.Level, calldepth int, record *logging.Record) error

Log is used to log a message as per the logging.Backend interface.

func (*Backend) Rotate

func (b *Backend) Rotate() error

Rotate simply reopens the log file for writing and should be used to implement log rotation where this is invoked upon HUP signal for example.

func (*Backend) SetLevel

func (b *Backend) SetLevel(level logging.Level, module string)

SetLevel sets the logging level for the specified module. The module corresponds to the string specified in GetLogger. We use this function as part of our implementation of the logging.Leveled interface.