log

Author: myxy99

xlog/api.go

@@ -2,26 +2,30 @@ package xlog
 
 import (
 	"go.uber.org/zap"
+	"sync"
 )
 
 func logger() *Logger {
-	if defaultLogger == nil {
+	one.Do(func() {
 		cfg := StdConfig()
 		defaultLogger = cfg.Build()
-	}
+	})
 	return defaultLogger
 }
 
 func DefaultLogger() *Logger {
 	return logger()
 }
 
-func SetDefaultLogger(o *options) {
-	defaultLogger = o.Build()
+func SetDefaultLogger(l *Logger) {
+	defaultLogger = l
 	return
 }
 
-var defaultLogger *Logger
+var (
+	defaultLogger *Logger
+	one           = sync.Once{}
+)
 
 // Auto ...
 func Auto(err error) Func {

xlog/field.go

@@ -38,6 +38,11 @@ func FieldCode(value int32) Field {
 	return Int32("code", value)
 }
 
+// FieldTid 设置链路id
+func FieldTid(value string) Field {
+	return String("tid", value)
+}
+
 func FieldSize(value int32) Field {
 	return Int32("size", value)
 }
@@ -91,10 +96,6 @@ func FieldMethod(value string) Field {
 	return String("method", value)
 }
 
-// FieldEvent ...
-func FieldEvent(value string) Field {
-	return String("event", value)
-}
 
 func FieldIp(value string) Field {
 	return String("ip", value)

xlog/log.go

@@ -59,20 +59,18 @@ func newLogger(o *options) *Logger {
 	if o.AddCaller {
 		zapOptions = append(zapOptions, zap.AddCaller(), zap.AddCallerSkip(o.CallerSkip))
 	}
-	if len(o.Fields) > 0 {
-		zapOptions = append(zapOptions, zap.Fields(o.Fields...))
+	if len(o.fields) > 0 {
+		zapOptions = append(zapOptions, zap.Fields(o.fields...))
 	}
 
-	var ws zapcore.WriteSyncer
+	var ws = zapcore.AddSync(newRotate(o))
 	if o.Debug {
-		ws = os.Stdout
-	} else {
-		ws = zapcore.AddSync(newRotate(o))
+		ws = zap.CombineWriteSyncers(os.Stdout, ws)
 	}
 
 	if o.Async {
 		var closeFunc CloseFunc
-		ws, closeFunc = Buffer(ws, defaultBufferSize, defaultFlushInterval)
+		ws, closeFunc = Buffer(ws, o.FlushBufferSize, o.FlushBufferInterval)
 
 		xdefer.Register(closeFunc)
 	}
@@ -82,8 +80,8 @@ func newLogger(o *options) *Logger {
 		panic(err)
 	}
 
-	encoderConfig := *o.EncoderConfig
-	core := o.Core
+	encoderConfig := *o.encoderConfig
+	core := o.core
 	if core == nil {
 		core = zapcore.NewCore(
 			func() zapcore.Encoder {

xlog/options.go

@@ -12,32 +12,24 @@ import (
 )
 
 type options struct {
-	// Dir 日志输出目录
-	Dir string `mapStructure:"dir"`
-	// Name 日志文件名称
-	Name string `mapStructure:"name"`
-	// Level 日志初始等级
-	Level string `mapStructure:"level"`
-	// 日志初始化字段
-	Fields []zap.Field `mapStructure:"fields"`
-	// 是否添加调用者信息
-	AddCaller bool `mapStructure:"add_caller"`
-	// 日志前缀
-	Prefix string `mapStructure:"prefix"`
-	// 日志输出文件最大长度，超过改值则截断
-	MaxSize   int `mapStructure:"max_size"`
-	MaxAge    int `mapStructure:"max_age"`
-	MaxBackup int `mapStructure:"max_backup"`
-	// 日志磁盘刷盘间隔
-	Interval      time.Duration          `mapStructure:"interval"`
-	CallerSkip    int                    `mapStructure:"caller_skip"`
-	Async         bool                   `mapStructure:"async"`
-	Queue         bool                   `mapStructure:"queue"`
-	QueueSleep    time.Duration          `mapStructure:"queue_sleep"`
-	Core          zapcore.Core           `mapStructure:"core"`
-	Debug         bool                   `mapStructure:"debug"`
-	EncoderConfig *zapcore.EncoderConfig `mapStructure:"encoder_config"`
-	ConfigKey     string                 `mapStructure:"config_key"`
+	Dir                 string        `mapStructure:"dir"`                   //Dir 日志输出目录
+	Name                string        `mapStructure:"name"`                  //Name 日志文件名称
+	Level               string        `mapStructure:"level"`                 //Level 日志初始等级
+	AddCaller           bool          `mapStructure:"add_caller"`            //是否添加调用者信息
+	MaxSize             int           `mapStructure:"max_size"`              //日志输出文件最大长度，超过改值则截断，默认500M
+	MaxAge              int           `mapStructure:"max_age"`               //日志存储最大时间，默认最大保存天数为7天
+	MaxBackup           int           `mapStructure:"max_backup"`            //日志存储最大数量，默认最大保存文件个数为10个
+	Interval            time.Duration `mapStructure:"interval"`              //日志轮转时间，默认1天
+	CallerSkip          int           `mapStructure:"caller_skip"`           //调用堆栈
+	Async               bool          `mapStructure:"async"`                 //是否异步，默认异步
+	ConfigKey           string        `mapStructure:"config_key"`            //config key
+	Debug               bool          `mapStructure:"debug"`                 //debug
+	FlushBufferSize     int           `mapStructure:"flush_buffer_size"`     //缓冲大小，默认256 * 1024B
+	FlushBufferInterval time.Duration `mapStructure:"flush_buffer_interval"` //缓冲时间，默认30秒
+
+	fields        []zap.Field            `mapStructure:"fields"` //日志初始化字段
+	encoderConfig *zapcore.EncoderConfig `mapStructure:"encoder_config"`
+	core          zapcore.Core           `mapStructure:"core"`
 }
 
 // Filename ...
@@ -70,32 +62,39 @@ func StdConfig(name ...string) *options {
 // DefaultConfig ...
 func defaultConfig() *options {
 	return &options{
-		Name:          "log.log",
-		Dir:           ".",
-		Level:         "",
-		MaxSize:       500, // 500M
-		MaxAge:        1,   // 1 day
-		MaxBackup:     10,  // 10 backup
-		Interval:      24 * time.Hour,
-		CallerSkip:    2,
-		AddCaller:     true,
-		Debug:         true,
-		Async:         false,
-		Queue:         false,
-		QueueSleep:    100 * time.Millisecond,
-		EncoderConfig: DefaultZapConfig(),
+		Dir:                 ".",
+		Name:                "log.log",
+		Level:               "info",
+		AddCaller:           true,
+		MaxSize:             500, // 500M
+		MaxAge:              1,   // 1 day
+		MaxBackup:           10,  // 10 backup
+		Interval:            24 * time.Hour,
+		CallerSkip:          2,
+		Async:               false,
+		ConfigKey:           "xlog",
+		Debug:               true,
+		FlushBufferSize:     defaultBufferSize,
+		FlushBufferInterval: defaultFlushInterval,
+		fields:              nil,
+		encoderConfig:       DefaultZapConfig(),
+		core:                nil,
 	}
 }
 
 // Build ...
-func (o options) Build() *Logger {
-	if o.EncoderConfig == nil {
-		o.EncoderConfig = DefaultZapConfig()
+func (o *options) Build(options ...Option) *Logger {
+	for _, option := range options {
+		option(o)
+	}
+	if o.encoderConfig == nil {
+		o.encoderConfig = DefaultZapConfig()
 	}
 	if o.Debug {
-		o.EncoderConfig.EncodeLevel = DebugEncodeLevel
+		o.encoderConfig.EncodeLevel = DebugEncodeLevel
+		o.encoderConfig.EncodeTime = timeDebugEncoder
 	}
-	logger := newLogger(&o)
+	logger := newLogger(o)
 	if o.ConfigKey != "" {
 		logger.AutoLevel(o.ConfigKey + ".level")
 	}
@@ -137,3 +136,51 @@ func DebugEncodeLevel(lv zapcore.Level, enc zapcore.PrimitiveArrayEncoder) {
 func timeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
 	enc.AppendInt64(t.Unix())
 }
+
+func timeDebugEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
+	enc.AppendString(t.Format("2006-01-02 15:04:05"))
+}
+
+// Option 可选项
+type Option func(c *options)
+
+// WithFileName 设置文件名
+func WithFileName(name string) Option {
+	return func(c *options) {
+		c.Name = name
+	}
+}
+
+// WithDebug 设置在命令行显示
+func WithDebug(debug bool) Option {
+	return func(c *options) {
+		c.Debug = debug
+	}
+}
+
+// WithLevel 设置级别
+func WithLevel(level string) Option {
+	return func(c *options) {
+		c.Level = level
+	}
+}
+
+// WithEnableAsync 是否异步执行，默认异步
+func WithEnableAsync(enableAsync bool) Option {
+	return func(c *options) {
+		c.Async = enableAsync
+	}
+}
+
+// WithEnableAddCaller 是否添加行号，默认不添加行号
+func WithEnableAddCaller(enableAddCaller bool) Option {
+	return func(c *options) {
+		c.AddCaller = enableAddCaller
+	}
+}
+
+func WithFields(f []Field) Option {
+	return func(c *options) {
+		c.fields = f
+	}
+}