logger

Documentation

Index

• func V(lvl Level, log Logger) bool
• type Config
• type Level
  • func GetLevel(levelStr string) (Level, error)
  • func (l Level) Enabled(lvl Level) bool
  • func (l Level) String() string
• type Logger
  • func NewLogger(opts ...Option) Logger
• type Option
  • func WithCallerSkipCount(c int) Option
  • func WithContext(k, v interface{}) Option
  • func WithFields(fields map[string]interface{}) Option
  • func WithLevel(level Level) Option
  • func WithOutput(out io.Writer) Option
• type Options

Functions

func V

func V(lvl Level, log Logger) bool

Returns true if the given level is at or lower the current logger level.

Types

type Config

type Config struct {
	Target     string //日志输出目标。一般是console或者file
	LogFile    string //日志输出文件
	MaxSize    int    //日志文件最大尺寸
	MaxBackups int    //最大备份数
	MaxAge     int    //最大停留
	Level      int
}

type Level

type Level int8

const (
	// TraceLevel level. Designates finer-grained informational events than the Debug.
	TraceLevel Level = iota - 2
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel
	// InfoLevel is the default logging priority.
	// General operational entries about what's going on inside the application.
	InfoLevel
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel
	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
	ErrorLevel
	// FatalLevel level. Logs and then calls `logger.Exit(1)`. highest level of severity.
	FatalLevel
)

func GetLevel

func GetLevel(levelStr string) (Level, error)

GetLevel converts a level string into a logger Level value. returns an error if the input string does not match known values.

func (Level) Enabled

func (l Level) Enabled(lvl Level) bool

Enabled returns true if the given level is at or above this level.

func (Level) String

func (l Level) String() string

type Logger

type Logger interface {
	Warnf(format string, v ...interface{})
	Debugf(format string, v ...interface{})
	Errorf(format string, v ...interface{})
	Fatalf(format string, v ...interface{})
	Infof(format string, v ...interface{})

	// String returns the name of logger
	String() string

	Options() Options
}

var DefaultLogger Logger = NewLogger()

func NewLogger

func NewLogger(opts ...Option) Logger

NewLogger builds a new logger based on options.

type Option

type Option func(*Options)

func WithCallerSkipCount

func WithCallerSkipCount(c int) Option

WithCallerSkipCount set frame count to skip.

func WithContext

func WithContext(k, v interface{}) Option

WithContext set Context

func WithFields

func WithFields(fields map[string]interface{}) Option

WithFields set default fields for the logger.

func WithLevel

func WithLevel(level Level) Option

WithLevel set default level for the logger.

func WithOutput

func WithOutput(out io.Writer) Option

WithOutput set default output writer for the logger.

type Options

type Options struct {
	// It's common to set this to a file, or leave it default which is `os.Stderr`
	Out io.Writer
	// Alternative options
	Context context.Context
	// fields to always be logged
	Fields map[string]interface{}
	// Caller skip frame count for file:line info
	CallerSkipCount int
	// The logging level the logger should log at. default is `InfoLevel`
	Level Level
}