log

README

Log

Usage

Structured logging

logger := stdlog.NewLogger(stdlog.Writer(os.Stdout))
log := log.NewHelper("module_name", logger)
// Levels
log.Info("some log")
log.Infof("format %s", "some log")
log.Infow("field_name", "some log")

Documentation

Index

• Constants
• type Helper
  • func NewHelper(name string, logger Logger) *Helper
  • func (h *Helper) Debug(a ...interface{})
  • func (h *Helper) Debugf(format string, a ...interface{})
  • func (h *Helper) Debugw(kvpair ...interface{})
  • func (h *Helper) Error(a ...interface{})
  • func (h *Helper) Errorf(format string, a ...interface{})
  • func (h *Helper) Errorw(kvpair ...interface{})
  • func (h *Helper) Info(a ...interface{})
  • func (h *Helper) Infof(format string, a ...interface{})
  • func (h *Helper) Infow(kvpair ...interface{})
  • func (h *Helper) Warn(a ...interface{})
  • func (h *Helper) Warnf(format string, a ...interface{})
  • func (h *Helper) Warnw(kvpair ...interface{})
• type Level
  • func (l Level) Enabled(lv Level) bool
  • func (l Level) String() string
• type Logger
  • func Debug(log Logger) Logger
  • func Error(log Logger) Logger
  • func Info(log Logger) Logger
  • func NewStdLogger(w io.Writer) Logger
  • func Warn(log Logger) Logger
  • func With(log Logger, pairs ...interface{}) Logger
  • func Wrap(l ...Logger) Logger

Constants

const (
	// LevelKey is logger level key.
	LevelKey = "level"
)

Types

type Helper

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

Helper is a logger helper.

func NewHelper

func NewHelper(name string, logger Logger) *Helper

NewHelper new a logger helper.

func (*Helper) Debug

func (h *Helper) Debug(a ...interface{})

Debug logs a message at debug level.

func (*Helper) Debugf

func (h *Helper) Debugf(format string, a ...interface{})

Debugf logs a message at debug level.

func (*Helper) Debugw

func (h *Helper) Debugw(kvpair ...interface{})

Debugw logs a message at debug level.

func (*Helper) Error

func (h *Helper) Error(a ...interface{})

Error logs a message at error level.

func (*Helper) Errorf

func (h *Helper) Errorf(format string, a ...interface{})

Errorf logs a message at error level.

func (*Helper) Errorw

func (h *Helper) Errorw(kvpair ...interface{})

Errorw logs a message at error level.

func (*Helper) Info

func (h *Helper) Info(a ...interface{})

Info logs a message at info level.

func (*Helper) Infof

func (h *Helper) Infof(format string, a ...interface{})

Infof logs a message at info level.

func (*Helper) Infow

func (h *Helper) Infow(kvpair ...interface{})

Infow logs a message at info level.

func (*Helper) Warn

func (h *Helper) Warn(a ...interface{})

Warn logs a message at warn level.

func (*Helper) Warnf

func (h *Helper) Warnf(format string, a ...interface{})

Warnf logs a message at warnf level.

func (*Helper) Warnw

func (h *Helper) Warnw(kvpair ...interface{})

Warnw logs a message at warnf level.

type Level

type Level int8

Level is a logger level.

const (
	// LevelDebug is logger debug level.
	LevelDebug Level = iota
	// LevelInfo is logger info level.
	LevelInfo
	// LevelWarn is logger warn level.
	LevelWarn
	// LevelError is logger error level.
	LevelError
)

func (Level) Enabled

func (l Level) Enabled(lv Level) bool

Enabled compare whether the logging level is enabled.

func (Level) String

func (l Level) String() string

type Logger

type Logger interface {
	Print(pairs ...interface{})
}

Logger is a logger interface.

var (
	// DefaultLogger is default logger.
	DefaultLogger Logger = NewStdLogger(os.Stderr)
)

func Debug

func Debug(log Logger) Logger

Debug returns a debug logger.

func Error

func Error(log Logger) Logger

Error returns a error logger.

func Info

func Info(log Logger) Logger

Info returns a info logger.

func NewStdLogger

func NewStdLogger(w io.Writer) Logger

NewStdLogger new a std logger with options.

func Warn

func Warn(log Logger) Logger

Warn return a warn logger.

func With

func With(log Logger, pairs ...interface{}) Logger

With with logger kv pairs.

func Wrap

func Wrap(l ...Logger) Logger

Wrap wraps multi logger.