共计 4048 个字符,预计需要花费 11 分钟才能阅读完成。
简介:
日志是咱们开发程序必不可少的一部分,go 官网的提供的日志包默认性能很简洁,然而满足不了生产环境的全副需要(例如:更精密的日志级别、日志文件宰割,以及日志散发等)。尽管 Go 是新兴语言,然而 go 的生态圈还是很沉闷的,目前比拟风行的第三方开源 log 包有 seelog,zap,logrus,还有 beego 中的日志框架局部。明天咱们就着重讲一下 uber 的 zap 包,本文中难免会有谬误的中央,如有请分割自己,自己会及时更正。
zap 是 uber 开源的 Go 高性能日志库
Lumberjack 用于将日志写入滚动文件。zap 不反对文件归档,如果要反对文件按大小或者工夫归档,须要应用 lumberjack,lumberjack 也是 zap 官网举荐的。
怎么应用
下载安装这些步骤就不在赘述,讲 zap 的用法之前,咱们先来看一下 zap 的配置,上面是我罕用的配置
zap.Config{Level: zap.NewAtomicLevelAt(zap.DebugLevel),
Development: false,
DisableCaller: false,
DisableStacktrace: false,
Sampling: nil,
Encoding: "json",
EncoderConfig: zapcore.EncoderConfig{
MessageKey: "msg",
LevelKey: "level",
TimeKey: "time",
NameKey: "logger",
CallerKey: "file",
StacktraceKey: "stacktrace",
LineEnding: zapcore.DefaultLineEnding,
EncodeLevel: zapcore.LowercaseLevelEncoder,
EncodeTime: zapcore.ISO8601TimeEncoder,
EncodeDuration: zapcore.SecondsDurationEncoder,
EncodeCaller: zapcore.ShortCallerEncoder,
EncodeName: zapcore.FullNameEncoder,
},
OutputPaths: []string{"/tmp/zap.log"},
ErrorOutputPaths: []string{"/tmp/zap.log"},
InitialFields: map[string]interface{}{"app": "test",},
}
lumberjack.Logger{
Filename: logPath, // 日志文件门路
MaxSize: 128, // 每个日志文件保留的大小 单位:M
MaxAge: 7, // 文件最多保留多少天
MaxBackups: 30, // 日志文件最多保留多少个备份
Compress: false, // 是否压缩
}
-
zap 配置阐明
Level
:日志级别, 只不过它须要的类型是AtomicLevel
。所以须要应用zap.NewAtomicLevelAt
。func NewAtomicLevelAt(l zapcore.Level) AtomicLevel {a := NewAtomicLevel() a.SetLevel(l) return a } DebugLevel Level = iota - 1 // InfoLevel 默认级别 InfoLevel // WarnLevel WarnLevel // 我的项目运行中,谬误的日志 ErrorLevel // 记录一条音讯后,如果是开发环境,则调用 panic DPanicLevel // 记录一条音讯后,则调用 panic PanicLevel // 记录一条音讯后调用 os.Exit(1). FatalLevel
Development
:是否是开发环境。如果是开发模式,对DPanicLevel
进行堆栈跟踪DisableCaller
:不显示调用函数的文件名称和行号。默认状况下,所有日志都显示。DisableStacktrace
:是否禁用堆栈跟踪捕捉。默认对 Warn 级别以上和生产 error 级别以上的进行堆栈跟踪。Sampling
:抽样策略。设置为 nil 禁用采样。(我本人没用过,有需要的敌人能够钻研下)Encoding
:编码方式,反对json
,console
, 也反对自定义(须要通过RegisterEncoder
注册)EncoderConfig
:生成格局的一些配置,前面具体介绍OutputPaths
:是 url 或文件门路列表,用于写入日志输入。ErrorOutputPaths
:外部日志程序谬误门路列表。默认为规范谬误。InitialFields
:退出一些初始的字段数据,比方我的项目名EncoderConfig 配置阐明:
MessageKey:输出信息的 key 名 LevelKey:输入日志级别的 key 名 TimeKey:输入工夫的 key 名 NameKey CallerKey StacktraceKey 跟以上相似,看名字就晓得 LineEnding:每行的分隔符。根本 zapcore.DefaultLineEnding 即 "\\n" EncodeLevel:根本 zapcore.LowercaseLevelEncoder。将日志级别字符串转化为小写 EncodeTime:输入的工夫格局 EncodeDuration:个别 zapcore.SecondsDurationEncoder, 执行耗费的工夫转化成浮点型的秒 EncodeCaller:个别 zapcore.ShortCallerEncoder,以包 / 文件: 行号 格式化调用堆栈 EncodeName:可选值。
-
实在例子
需要:心愿日志文件依照肯定的大小分隔,备份,并且心愿,在开发的时候,日志能够在文件和管制台上都有输入,只须要通过配置就能管制
package logger import ( "xxx/config" "os" "github.com/natefinch/lumberjack" "go.uber.org/zap" "go.uber.org/zap/zapcore" ) var ZapLogger *zap.Logger func InitLogger() { // 此处的配置是从我的我的项目配置文件读取的,读者能够依据本人的状况来设置 logPath := config.Cfg.Section("app").Key("logPath").String() name := config.Cfg.Section("app").Key("name").String() debug, err := config.Cfg.Section("app").Key("debug").Bool() if err != nil {debug = false} hook := lumberjack.Logger{ Filename: logPath, // 日志文件门路 MaxSize: 128, // 每个日志文件保留的大小 单位:M MaxAge: 7, // 文件最多保留多少天 MaxBackups: 30, // 日志文件最多保留多少个备份 Compress: false, // 是否压缩 } encoderConfig := zapcore.EncoderConfig{ MessageKey: "msg", LevelKey: "level", TimeKey: "time", NameKey: "logger", CallerKey: "file", StacktraceKey: "stacktrace", LineEnding: zapcore.DefaultLineEnding, EncodeLevel: zapcore.LowercaseLevelEncoder, EncodeTime: zapcore.ISO8601TimeEncoder, EncodeDuration: zapcore.SecondsDurationEncoder, EncodeCaller: zapcore.ShortCallerEncoder, // 短门路编码器 EncodeName: zapcore.FullNameEncoder, } // 设置日志级别 atomicLevel := zap.NewAtomicLevel() atomicLevel.SetLevel(zap.DebugLevel) var writes = []zapcore.WriteSyncer{zapcore.AddSync(&hook)} // 如果是开发环境,同时在管制台上也输入 if debug {writes = append(writes, zapcore.AddSync(os.Stdout)) } core := zapcore.NewCore(zapcore.NewJSONEncoder(encoderConfig), zapcore.NewMultiWriteSyncer(writes...), atomicLevel, ) // 开启开发模式,堆栈跟踪 caller := zap.AddCaller() // 开启文件及行号 development := zap.Development() // 设置初始化字段 field := zap.Fields(zap.String("appName", name)) // 结构日志 ZapLogger = zap.New(core, caller, development, field) ZapLogger.Info("log 初始化胜利") }
从下面的例子中咱们分几步来看
- 首先先通过配置
lumberjack.Logger
,来设置日志文件的切割 - 通过配置
zapcore.EncoderConfig
,来设置日志的格局 - 通过
zapcore.NewMultiWriteSyncer(writes...)
来设置多个输入,和io.MultiWriter
很像。 - 通过
zapcore.NewCore
创立一个 core - 通过
zap.New
创立日志实例
当然本文没有介绍 zap 的其余根本用法,只是解说了自己常常用到的办法,其余办法如果有工夫,我也会一一列出。谢谢大家观看,比心~~