logger

Documentation

Overview

Package logger contains logger API definition, wrapper that can be used around any other logger.

Index

• Variables
• type Level
  • func (lvl Level) String() string
  • func (lvl *Level) UnmarshalText(text string) error
• type Logger
  • func New(out io.Writer, levelText string) (Logger, error)
  • func NewMock() Logger

Variables

var ErrInvalidLogLevel = errors.New("unrecognized log level")

ErrInvalidLogLevel indicates an unrecognized log level.

Types

type Level

type Level int

Level represents severity level while logging.

const (
	// Error level is used when logging errors.
	Error Level = iota + 1
	// Warn level is used when logging warnings.
	Warn
	// Info level is used when logging info data.
	Info
	// Debug level is used when logging debugging info.
	Debug
)

func (Level) String

func (lvl Level) String() string

func (*Level) UnmarshalText

func (lvl *Level) UnmarshalText(text string) error

UnmarshalText returns log Level for the given string representation.

type Logger

type Logger interface {
	// Debug logs any object in JSON format on debug level.
	Debug(string)
	// Info logs any object in JSON format on info level.
	Info(string)
	// Warn logs any object in JSON format on warning level.
	Warn(string)
	// Error logs any object in JSON format on error level.
	Error(string)
}

Logger specifies logging API.

func New

func New(out io.Writer, levelText string) (Logger, error)

New returns wrapped go kit logger.

func NewMock

func NewMock() Logger

NewMock returns wrapped go kit logger mock.