Golang日志库Zap基本使用

Zap

• Uber-go Zap简介
• Zap Logger
• • Logger
  • Sugared Logger
• 配置Logger
• • New函数详情
  • JSON Encoder
  • Log Encoder
  • 更改时间编码
  • 添加Option

Uber-go Zap简介

Zap是非常快的、结构化的，分日志级别的Go日志库。

go get -u go.uber.org/zap

readme
zap git

Zap Logger

Zap提供了两种类型的日志记录器—Sugared Logger和Logger。

在性能很好但不是很关键的上下文中，使用SugaredLogger。它比其他结构化日志记录包快4-10倍，并且支持结构化和printf风格的日志记录。

在每一微秒和每一次内存分配都很重要的上下文中，使用Logger。它甚至比SugaredLogger更快，内存分配次数也更少，但它只支持强类型的结构化日志记录。

Logger

• 通过调用zap.NewProduction()/zap.NewDevelopment()或者zap.Example()创建一个Logger。
• 上面的每一个函数都将创建一个logger。唯一的区别在于它将记录的信息不同。例如production logger默认记录调用函数信息、日期和时间等。
• 通过Logger调用Info/Error等。
• 默认情况下日志都会打印到应用程序的console界面。

package main

import (
	"net/http"

	"go.uber.org/zap"
)

var logger *zap.Logger

func main() {
	InitLogger()
	defer logger.Sync()
	simpleHttpGet("www.baidu.com")
	simpleHttpGet("https://www.baidu.com")
}

func InitLogger() {
	logger, _ = zap.NewProduction()
}

func simpleHttpGet(url string) {
	resp, err := http.Get(url)
	if err != nil {
		logger.Error(
			"Error fetching url..",
			zap.String("url", url),
			zap.Error(err))
	} else {
		logger.Info("Success..",
			zap.String("statusCode", resp.Status),
			zap.String("url", url))
		resp.Body.Close()
	}
}

在上面的代码中，我们首先创建了一个Logger，然后使用Info/ Error等Logger方法记录消息。
日志记录器方法的语法是这样的

func (log *Logger) MethodXXX(msg string, fields ...Field)
func (log *Logger) Error(msg string, fields ...Field)
func (log *Logger) Info(msg string, fields ...Field)

其中MethodXXX是一个可变参数函数，可以是Info / Error/ Debug / Panic等
每个方法都接受一个消息字符串和任意数量的zapcore.Field参数。

type Field = zapcore.Field
//zapcore.Field的别名是Field ，而Field只是一个别名，并非一个新的数据类型

每个zapcore.Field其实就是一组键值对参数

func String(key string, val string) Field

执行上面的代码会得到如下输出结果

{"level":"error","ts":1635409221.114068,"caller":"ZapTest/main.go:25","msg":"Error fetching url..","url":"www.baidu.com","error":"Get \"www.baidu.com\": unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tC:/Users/68725/Desktop/ZapTest/main.go:25\nmain.main\n\tC:/Users/68725/Desktop/ZapTest/main.go:14\nruntime.main\n\tC:/Program Files/Go/src/runtime/proc.go:255"}
{"level":"info","ts":1635409221.3083706,"caller":"ZapTest/main.go:30","msg":"Success..","statusCode":"200 OK","url":"https://www.baidu.com"}

可以看到输出是json格式的

Sugared Logger

现在让我们使用Sugared Logger来实现相同的功能。

• 大部分的实现基本都相同。
• 惟一的区别是，我们通过调用主logger的.Sugar()方法来获取一个SugaredLogger。
• 然后使用SugaredLogger以printf格式记录语句

下面是修改过后使用SugaredLogger代替Logger的代码

package main

import (
	"go.uber.org/zap"
	"net/http"
)

var sugarLogger *zap.SugaredLogger

func main() {
	InitLogger()
	defer sugarLogger.Sync()
	simpleHttpGet("www.baidu.com")
	simpleHttpGet("https://www.baidu.com")
}

func InitLogger() {
	logger, _ := zap.NewProduction()
	sugarLogger = logger.Sugar()
}

func simpleHttpGet(url string) {
	sugarLogger.Debugf("Trying to hit GET request for %s", url)
	resp, err := http.Get(url)
	if err != nil {
		sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
	} else {
		sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
		resp.Body.Close()
	}
}

{"level":"error","ts":1635410289.9507382,"caller":"ZapTest/sugarloggermain.go:26","msg":"Error fetching URL www.baidu.com : Error = Get \"www.baidu.com\": unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\tC:/Users/68725/Desktop/ZapTest/sugarloggermain.go:26\nmain.main\n\tC:/Users/68725/Desktop/ZapTest/sugarloggermain.go:13\nruntime.main\n\tC:/Program Files/Go/src/runtime/proc.go:255"}
{"level":"info","ts":1635410290.1244514,"caller":"ZapTest/sugarloggermain.go:28","msg":"Success! statusCode = 200 OK for URL https://www.baidu.com"}

可以看到输出是json格式的,到目前为止这两个logger都打印输出JSON结构格式。

配置Logger

New函数详情

我们要做的第一个更改是把日志写入文件，而不是打印到应用程序控制台。

func New(core zapcore.Core, options ...Option) *Logger

func NewCore(enc Encoder, ws WriteSyncer, enab LevelEnabler) Core

zapcore.Core需要三个配置——Encoder，WriteSyncer，LogLevel

1. Encoder:编码器(如何写入日志)。我们将使用开箱即用的NewJSONEncoder()，并使用预先设置的ProductionEncoderConfig()。

func NewJSONEncoder(cfg EncoderConfig) Encoder

zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())

2. WriterSyncer ：指定日志将写到哪里去。我们使用zapcore.AddSync()函数并且将打开的文件句柄传进去。

func AddSync(w io.Writer) WriteSyncer

file, _ := os.Create("./test.log")
writeSyncer := zapcore.AddSync(file)

3. Log Level：哪种级别的日志将被写入。

const (
	// DebugLevel logs are typically voluminous, and are usually disabled in
	// production.
	DebugLevel Level = iota - 1
	// InfoLevel is the default logging priority.
	InfoLevel
	// WarnLevel logs are more important than Info, but don't need individual
	// human review.
	WarnLevel
	// ErrorLevel logs are high-priority. If an application is running smoothly,
	// it shouldn't generate any error-level logs.
	ErrorLevel
	// DPanicLevel logs are particularly important errors. In development the
	// logger panics after writing the message.
	DPanicLevel
	// PanicLevel logs a message, then panics.
	PanicLevel
	// FatalLevel logs a message, then calls os.Exit(1).
	FatalLevel

	_minLevel = DebugLevel
	_maxLevel = FatalLevel
)

JSON Encoder

package main

import (
	"net/http"
	"os"

	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)

var sugarLogger *zap.SugaredLogger

func main() {
	InitLogger()
	defer sugarLogger.Sync()
	simpleHttpGet("www.baidu.com")
	simpleHttpGet("https://www.baidu.com")
}

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)

	logger := zap.New(core)
	sugarLogger = logger.Sugar()
}

func getEncoder() zapcore.Encoder {
	return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
}

func getLogWriter() zapcore.WriteSyncer {
	//如果想要追加写入可以查看我的博客文件操作那一章
	file, _ := os.Create("./test.log")
	return zapcore.AddSync(file)
}

func simpleHttpGet(url string) {
	sugarLogger.Debugf("Trying to hit GET request for %s", url)
	resp, err := http.Get(url)
	if err != nil {
		sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
	} else {
		sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
		resp.Body.Close()
	}
}

当使用这些修改过的logger配置调用上述部分的main()函数时，以下输出将打印在文件——test.log中。

{"level":"debug","ts":1635411255.8650641,"msg":"Trying to hit GET request for www.baidu.com"}
{"level":"error","ts":1635411255.8650641,"msg":"Error fetching URL www.baidu.com : Error = Get \"www.baidu.com\": unsupported protocol scheme \"\""}
{"level":"debug","ts":1635411255.8650641,"msg":"Trying to hit GET request for https://www.baidu.com"}
{"level":"info","ts":1635411256.1213775,"msg":"Success! statusCode = 200 OK for URL https://www.baidu.com"}

Log Encoder

现在，我们希望将编码器从JSON Encoder更改为普通Encoder。为此，我们需要将NewJSONEncoder()更改为NewConsoleEncoder()。

func getEncoder() zapcore.Encoder {
	//return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
	return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
}

当使用这些修改过的logger配置调用上述部分的main()函数时，以下输出将打印在文件——test.log中。

更改时间编码

鉴于我们对配置所做的更改，有下面两个问题：

• 时间是以非人类可读的方式展示，例如1.6354115057944e+09
• 我们要做的第一件事是覆盖默认的ProductionConfig()

func getEncoder() zapcore.Encoder {
	//return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
	//return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder//更改时间编码
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder//在日志文件中使用大写字母记录日志级别
	return zapcore.NewConsoleEncoder(encoderConfig)
}

添加Option

我们修改zap.New()代码，添加将调用函数信息记录到日志中的功能。为此，我们将在zap.New(…)函数中添加一个Option。

logger := zap.New(core, zap.AddCaller())

结果：