zlog

README

https://jianghushinian.cn/2023/03/19/use-of-zap-in-go-third-party-log-library/

https://jianghushinian.cn/2023/04/16/how-to-wrap-a-more-user-friendly-logging-package-based-on-zap/

Documentation

Index

• Constants
• Variables
• func Debug(msg string, fields ...Field)
• func Error(msg string, fields ...Field)
• func Fatal(msg string, fields ...Field)
• func Info(msg string, fields ...Field)
• func NewProductionRotateBySize(filename string) io.Writer
• func NewProductionRotateByTime(filename string) io.Writer
• func NewRotateBySize(cfg *RotateConfig) io.Writer
• func NewRotateByTime(cfg *RotateConfig) io.Writer
• func Panic(msg string, fields ...Field)
• func ReplaceDefault(l *Logger)
• func SetLevel(level Level)
• func Sync() error
• func Warn(msg string, fields ...Field)
• type Field
• type Level
• type LevelEnablerFunc
• type Logger
  • func Default() *Logger
  • func New(out io.Writer, level Level, opts ...Option) *Logger
  • func NewTee(tees []TeeOption, opts ...Option) *Logger
  • func (l *Logger) Debug(msg string, fields ...Field)
  • func (l *Logger) Error(msg string, fields ...Field)
  • func (l *Logger) Fatal(msg string, fields ...Field)
  • func (l *Logger) Info(msg string, fields ...Field)
  • func (l *Logger) Panic(msg string, fields ...Field)
  • func (l *Logger) SetLevel(level Level)
  • func (l *Logger) Sync() error
  • func (l *Logger) Warn(msg string, fields ...Field)
• type Option
• type RotateConfig
  • func NewProductionRotateConfig(filename string) *RotateConfig
• type TeeOption

Constants

const (
	DebugLevel = zapcore.DebugLevel
	InfoLevel  = zapcore.InfoLevel
	WarnLevel  = zapcore.WarnLevel
	ErrorLevel = zapcore.ErrorLevel
	PanicLevel = zapcore.PanicLevel
	FatalLevel = zapcore.FatalLevel
)

Variables

var (
	Skip        = zap.Skip
	Binary      = zap.Binary
	Bool        = zap.Bool
	Boolp       = zap.Boolp
	ByteString  = zap.ByteString
	Complex128  = zap.Complex128
	Complex128p = zap.Complex128p
	Complex64   = zap.Complex64
	Complex64p  = zap.Complex64p
	Float64     = zap.Float64
	Float64p    = zap.Float64p
	Float32     = zap.Float32
	Float32p    = zap.Float32p
	Int         = zap.Int
	Intp        = zap.Intp
	Int64       = zap.Int64
	Int64p      = zap.Int64p
	Int32       = zap.Int32
	Int32p      = zap.Int32p
	Int16       = zap.Int16
	Int16p      = zap.Int16p
	Int8        = zap.Int8
	Int8p       = zap.Int8p
	String      = zap.String
	Stringp     = zap.Stringp
	Uint        = zap.Uint
	Uintp       = zap.Uintp
	Uint64      = zap.Uint64
	Uint64p     = zap.Uint64p
	Uint32      = zap.Uint32
	Uint32p     = zap.Uint32p
	Uint16      = zap.Uint16
	Uint16p     = zap.Uint16p
	Uint8       = zap.Uint8
	Uint8p      = zap.Uint8p
	Uintptr     = zap.Uintptr
	Uintptrp    = zap.Uintptrp
	Reflect     = zap.Reflect
	Namespace   = zap.Namespace
	Stringer    = zap.Stringer
	Time        = zap.Time
	Timep       = zap.Timep
	Stack       = zap.Stack
	StackSkip   = zap.StackSkip
	Duration    = zap.Duration
	Durationp   = zap.Durationp
	Object      = zap.Object
	Inline      = zap.Inline
	Errors      = zap.Error
	Any         = zap.Any
)

var (
	WrapCore      = zap.WrapCore
	Hooks         = zap.Hooks
	Fields        = zap.Fields
	ErrorOutput   = zap.ErrorOutput
	Development   = zap.Development
	AddCaller     = zap.AddCaller
	WithCaller    = zap.WithCaller
	AddCallerSkip = zap.AddCallerSkip
	AddStacktrace = zap.AddStacktrace
	IncreaseLevel = zap.IncreaseLevel
	WithFatalHook = zap.WithFatalHook
	WithClock     = zap.WithClock
)

Functions

func Debug

func Debug(msg string, fields ...Field)

func Error

func Error(msg string, fields ...Field)

func Fatal

func Fatal(msg string, fields ...Field)

func Info

func Info(msg string, fields ...Field)

func NewProductionRotateBySize

func NewProductionRotateBySize(filename string) io.Writer

func NewProductionRotateByTime

func NewProductionRotateByTime(filename string) io.Writer

func NewRotateBySize

func NewRotateBySize(cfg *RotateConfig) io.Writer

func NewRotateByTime

func NewRotateByTime(cfg *RotateConfig) io.Writer

func Panic

func Panic(msg string, fields ...Field)

func ReplaceDefault

func ReplaceDefault(l *Logger)

func SetLevel

func SetLevel(level Level)

func Sync

func Sync() error

func Warn

func Warn(msg string, fields ...Field)

Types

type Field

type Field = zap.Field

type Level

type Level = zapcore.Level

type LevelEnablerFunc

type LevelEnablerFunc func(level Level) bool

type Logger

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

func Default

func Default() *Logger

func New

func New(out io.Writer, level Level, opts ...Option) *Logger

func NewTee

func NewTee(tees []TeeOption, opts ...Option) *Logger

func (*Logger) Debug

func (l *Logger) Debug(msg string, fields ...Field)

func (*Logger) Error

func (l *Logger) Error(msg string, fields ...Field)

func (*Logger) Fatal

func (l *Logger) Fatal(msg string, fields ...Field)

func (*Logger) Info

func (l *Logger) Info(msg string, fields ...Field)

func (*Logger) Panic

func (l *Logger) Panic(msg string, fields ...Field)

func (*Logger) SetLevel

func (l *Logger) SetLevel(level Level)

func (*Logger) Sync

func (l *Logger) Sync() error

func (*Logger) Warn

func (l *Logger) Warn(msg string, fields ...Field)

type Option

type Option = zap.Option

type RotateConfig

type RotateConfig struct {
	// 共用配置
	Filename string // 完整配置名
	MaxAge   int    // 保留旧日志文件最大时间

	// 按时间轮转配置
	RotationTime time.Duration

	// 按大小轮转配置
	MaxSize    int  // 日志文件最大大小
	MaxBackups int  // 保留日志文件的最大数量
	Compress   bool // 是否对日志文件进行压缩
	LocalTime  bool // 是否使用本地时间
}

func NewProductionRotateConfig

func NewProductionRotateConfig(filename string) *RotateConfig

type TeeOption

type TeeOption struct {
	Out io.Writer
	LevelEnablerFunc
}