logger

Documentation

Index

• Constants
• func Byte2(level int8, b []byte) string
• func Configure(config Config, opts ...Option) error
• func Context() *zap.Logger
• func D(msg, format string, args ...interface{})
• func DObjectTo(o any) string
• func DTraceId(ctx context.Context) string
• func Debug(format string, args ...interface{})
• func E(msg, format string, args ...interface{})
• func EObjectTo(o any) string
• func ETraceId(ctx context.Context) string
• func Error(format string, args ...interface{})
• func F(msg, format string, args ...interface{})
• func Fatal(format string, args ...interface{})
• func I(msg, format string, args ...interface{})
• func IObjectTo(o any) string
• func ITraceId(ctx context.Context) string
• func Info(format string, args ...interface{})
• func IsNDebug() bool
• func L() *zap.Logger
• func N(msg, format string, args ...interface{})
• func NDebug(format string, args ...interface{})
• func NObjectTo(o any) string
• func NTraceId(ctx context.Context) string
• func ObjectTo(o any) string
• func P(msg, format string, args ...interface{})
• func Panic(format string, args ...interface{})
• func Recover(callerSkip int, err interface{})
• func SetNDebug(enable bool)
• func SpecW(level int8, msg string, fields ...zapcore.Field)
• func TraceId(ctx context.Context) string
• func W(msg, format string, args ...interface{})
• func WObjectTo(o any) string
• func WTraceId(ctx context.Context) string
• func Warn(format string, args ...interface{})
• func ZLog(info string) zap.Field
• func ZLogf(format string, args ...any) zap.Field
• type Config
• type Decorate
  • func (d *Decorate) UseObject()
  • func (d *Decorate) UseSlice()
• type FileConfig
• type Option
  • func WithHook(hook func(entry zapcore.Entry) error) Option
  • func WithNDebug(enabled bool) Option
  • func WithWriterLevel(level int8, w io.Writer) Option
  • func WithWriterType(writeType string, w io.Writer) Option
• type WriterConfig

Constants

const (
	// RecoverLevel ()
	RecoverLevel = int8(-3)
	// NDebugLevel ()
	NDebugLevel = int8(-2)

	DebugLevel = int8(zap.DebugLevel)
	InfoLevel  = int8(zap.InfoLevel)
	// WarnLevel defines warn log level.
	WarnLevel = int8(zap.WarnLevel)
	// ErrorLevel defines error log level.
	ErrorLevel = int8(zap.ErrorLevel)
	// FatalLevel defines fatal log level.
	FatalLevel = int8(zap.FatalLevel)
	// PanicLevel defines panic log level.
	PanicLevel = int8(zap.PanicLevel)
)

对外进行统一的封装

Functions

func Byte2

func Byte2(level int8, b []byte) string

func Configure

func Configure(config Config, opts ...Option) error

func Context

func Context() *zap.Logger

Context Deprecated: this function simply calls L.

func D

func D(msg, format string, args ...interface{})

func DObjectTo

func DObjectTo(o any) string

func DTraceId

func DTraceId(ctx context.Context) string

func Debug

func Debug(format string, args ...interface{})

func E

func E(msg, format string, args ...interface{})

E defines error log level.

func EObjectTo

func EObjectTo(o any) string

func ETraceId

func ETraceId(ctx context.Context) string

func Error

func Error(format string, args ...interface{})

Error defines error log level.

func F

func F(msg, format string, args ...interface{})

F defines fatal log level.

func Fatal

func Fatal(format string, args ...interface{})

Fatal defines fatal log level.

func I

func I(msg, format string, args ...interface{})

I defines info log level.

func IObjectTo

func IObjectTo(o any) string

func ITraceId

func ITraceId(ctx context.Context) string

func Info

func Info(format string, args ...interface{})

Info defines info log level.

func IsNDebug

func IsNDebug() bool

func L

func L() *zap.Logger

func N

func N(msg, format string, args ...interface{})

func NDebug

func NDebug(format string, args ...interface{})

NDebug *

正式环境，不输出日志

func NObjectTo

func NObjectTo(o any) string

func NTraceId

func NTraceId(ctx context.Context) string

func ObjectTo

func ObjectTo(o any) string

func P

func P(msg, format string, args ...interface{})

P (format string, args ...interface{}) { defines panic log level.

func Panic

func Panic(format string, args ...interface{})

Panic (format string, args ...interface{}) { defines panic log level.

func Recover

func Recover(callerSkip int, err interface{})

Recover defines error log level.

func SetNDebug

func SetNDebug(enable bool)

func SpecW

func SpecW(level int8, msg string, fields ...zapcore.Field)

func TraceId

func TraceId(ctx context.Context) string

func W

func W(msg, format string, args ...interface{})

W defines warn log level.

func WObjectTo

func WObjectTo(o any) string

func WTraceId

func WTraceId(ctx context.Context) string

func Warn

func Warn(format string, args ...interface{})

Warn defines warn log level.

func ZLog

func ZLog(info string) zap.Field

func ZLogf

func ZLogf(format string, args ...any) zap.Field

Types

type Config

type Config struct {
	Level          int8           `json:"level" yaml:"level" xml:"level"`
	NDebug         bool           `json:"nDebug" yaml:"nDebug" xml:"nDebug"`
	WriterEnabled  bool           `json:"writerEnabled" yaml:"writerEnabled" xml:"writerEnabled"` // 自己实现writer
	ConsoleEnabled bool           `json:"console" yaml:"console" xml:"console"`
	FileEnabled    bool           `json:"fileEnabled" yaml:"fileEnabled" xml:"fileEnabled"`
	EncoderFormat  string         `json:"encoderFormat" yaml:"encoderFormat" xml:"encoderFormat"`
	FilePath       string         `json:"filePath" yaml:"filePath" xml:"filePath"`
	FileConfigs    []FileConfig   `json:"fileConfigs" yaml:"fileConfigs" xml:"fileConfigs"`
	WriterConfigs  []WriterConfig `json:"writerConfigs" yaml:"writerConfigs" xml:"writerConfigs"`
	// contains filtered or unexported fields
}

type Decorate

type Decorate struct {
	S string
	E string
}

func (*Decorate) UseObject

func (d *Decorate) UseObject()

func (*Decorate) UseSlice

func (d *Decorate) UseSlice()

type FileConfig

type FileConfig struct {
	MinLevel int8 `json:"minLevel" yaml:"minLevel" xml:"minLevel"`
	MaxLevel int8 `json:"maxLevel" yaml:"maxLevel" xml:"maxLevel"`
	// Name is the name of the logfile which will be placed inside the directory
	Name string `json:"name" yaml:"name" xml:"name"`
	// MaxSize the max size in MB of the logfile before it's rolled
	MaxSize int `json:"maxSize" yaml:"maxSize" xml:"maxSize"`
	// MaxBackups the max number of rolled files to keep
	MaxBackups int `json:"backupNum" yaml:"backupNum" xml:"backupNum"`
	// MaxAge the max age in days to keep a logfile
	MaxAge int `json:"days" json:"days" xml:"days"`
}

type Option

type Option func(config *Config)

func WithHook

func WithHook(hook func(entry zapcore.Entry) error) Option

func WithNDebug

func WithNDebug(enabled bool) Option

func WithWriterLevel

func WithWriterLevel(level int8, w io.Writer) Option

func WithWriterType

func WithWriterType(writeType string, w io.Writer) Option

type WriterConfig

type WriterConfig struct {
	MinLevel  int8   `json:"minLevel" yaml:"minLevel" xml:"minLevel"`
	MaxLevel  int8   `json:"maxLevel" yaml:"maxLevel" xml:"maxLevel"`
	WriteType string `json:"type" yaml:"type" xml:"type"`
	// contains filtered or unexported fields
}