logger

Documentation

Index

• Constants
• func NewJSONLogger(opts ...Option) (*zap.Logger, error)
• func NewLogger(text bool, opts ...Option) (*zap.Logger, error)
• func NewTextLogger(opts ...Option) (*zap.Logger, error)
• func WrapMeta(err error, metas ...Meta) (fields []zap.Field)
• type LogAppender
• type LogAppenderCfg
• type LogLevel
• type LogModule
  • func GetDefLogCfg(logFile string) *LogModule
  • func InitLogModuleCfg(baseCfg *LogModule, logModuleCfg *LogModule, moduleDefLogFile string) *LogModule
  • func InitLogModuleCfgWithoutGlob(logModuleCfg *LogModule, moduleDefLogFile string) *LogModule
• type Meta
  • func NewMeta(key string, value interface{}) Meta
• type Option
  • func WithConsoleAppender(appender LogAppender) Option
  • func WithConsoleDisable(disabled bool) Option
  • func WithConsoleLevel(level zapcore.Level) Option
  • func WithConsoleText(text bool) Option
  • func WithDebugLevel() Option
  • func WithErrorLevel() Option
  • func WithField(key, value string) Option
  • func WithFileP(file string) Option
  • func WithFileRotationP(file string) Option
  • func WithInfoLevel() Option
  • func WithLevel(level zapcore.Level) Option
  • func WithLevelStr(level zapcore.Level) Option
  • func WithNoCaller(noCaller bool) Option
  • func WithText(text bool) Option
  • func WithTimeLayout(timeLayout string) Option
  • func WithWarnLevel() Option

Constants

const (
	// DefaultLevel the default log level
	DefaultLevel = zapcore.InfoLevel

	// DefaultTimeLayout the default time layout;
	DefaultTimeLayout = time.RFC3339
)

Functions

func NewJSONLogger

func NewJSONLogger(opts ...Option) (*zap.Logger, error)

NewJSONLogger return a json-encoder zap logger,

func NewLogger

func NewLogger(text bool, opts ...Option) (*zap.Logger, error)

NewLogger return a json-encoder zap logger,

func NewTextLogger

func NewTextLogger(opts ...Option) (*zap.Logger, error)

NewTextLogger return a json-encoder zap logger,

func WrapMeta

func WrapMeta(err error, metas ...Meta) (fields []zap.Field)

WrapMeta wrap meta to zap fields

Types

type LogAppender

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

type LogAppenderCfg

type LogAppenderCfg struct {
	Disabled *bool          `yaml:"disabled"` // disabled
	Text     *bool          `yaml:"text"`     // json or text format
	Level    *zapcore.Level `yaml:"level"`    // int8 ?
	Path     string         `yaml:"path"`     // file path, for file appender, useless for console
}

type LogLevel

type LogLevel = zapcore.Level

type LogModule

type LogModule struct {
	File      *LogAppenderCfg  `yaml:"file"`      // for file appender
	Console   *LogAppenderCfg  `yaml:"console"`   // for console appender
	Appenders []LogAppenderCfg `yaml:"appenders"` // other appenders
}

func GetDefLogCfg

func GetDefLogCfg(logFile string) *LogModule

func InitLogModuleCfg

func InitLogModuleCfg(baseCfg *LogModule, logModuleCfg *LogModule, moduleDefLogFile string) *LogModule

fill default data for log module, otherwise some value will be nil

func InitLogModuleCfgWithoutGlob

func InitLogModuleCfgWithoutGlob(logModuleCfg *LogModule, moduleDefLogFile string) *LogModule

type Meta

type Meta interface {
	Key() string
	Value() interface{}
	// contains filtered or unexported methods
}

Meta key-value

func NewMeta

func NewMeta(key string, value interface{}) Meta

NewMeta create meat

type Option

type Option func(*option)

Option custom setup config

func WithConsoleAppender

func WithConsoleAppender(appender LogAppender) Option

func WithConsoleDisable

func WithConsoleDisable(disabled bool) Option

WithConsoleDisable write log to os.Stdout or os.Stderr

func WithConsoleLevel

func WithConsoleLevel(level zapcore.Level) Option

func WithConsoleText

func WithConsoleText(text bool) Option

func WithDebugLevel

func WithDebugLevel() Option

WithDebugLevel only greater than 'level' will output

func WithErrorLevel

func WithErrorLevel() Option

WithErrorLevel only greater than 'level' will output

func WithField

func WithField(key, value string) Option

WithField add some field(s) to log

func WithFileP

func WithFileP(file string) Option

WithFileP write log to some file

func WithFileRotationP

func WithFileRotationP(file string) Option

WithFileRotationP write log to some file with rotation

func WithInfoLevel

func WithInfoLevel() Option

WithInfoLevel only greater than 'level' will output

func WithLevel

func WithLevel(level zapcore.Level) Option

WithDebugLevel only greater than 'level' will output

func WithLevelStr

func WithLevelStr(level zapcore.Level) Option

WithDebugLevel only greater than 'level' will output

func WithNoCaller

func WithNoCaller(noCaller bool) Option

default is with caller

func WithText

func WithText(text bool) Option

default is json

func WithTimeLayout

func WithTimeLayout(timeLayout string) Option

WithTimeLayout custom time format

func WithWarnLevel

func WithWarnLevel() Option

WithWarnLevel only greater than 'level' will output