您现在的位置是：网站首页> 编程资料编程资料
golang默认Logger日志库在项目中使用Zap日志库_Golang_
2023-05-26
452人已围观
简介 golang默认Logger日志库在项目中使用Zap日志库_Golang_
在Go语言项目中使用Zap日志库介绍
在许多Go语言项目中，我们需要一个好的日志记录器能够提供下面这些功能：
- 能够将事件记录到文件中，而不是应用程序控制台。
- 日志切割-能够根据文件大小、时间或间隔等来切割日志文件。
- 支持不同的日志级别。例如INFO，DEBUG，ERROR等。
- 能够打印基本信息，如调用文件/函数名和行号，日志时间等。
默认的Go Logger日志库
在介绍Uber-go的zap包之前，让我们先看看Go语言提供的基本日志功能。Go语言提供的默认日志包是https://golang.org/pkg/log/。
实现Go Logger
实现一个Go语言中的日志记录器非常简单——创建一个新的日志文件，然后设置它为日志的输出位置。
设置Logger
我们可以像下面的代码一样设置日志记录器
func SetupLogger() { logFileLocation, _ := os.OpenFile("/Users/q1mi/test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744) log.SetOutput(logFileLocation) } 使用Logger
让我们来写一些虚拟的代码来使用这个日志记录器。
在当前的示例中，我们将建立一个到URL的HTTP连接，并将状态代码/错误记录到日志文件中。
func simpleHttpGet(url string) { resp, err := http.Get(url) if err != nil { log.Printf("Error fetching url %s : %s", url, err.Error()) } else { log.Printf("Status Code for %s : %s", url, resp.Status) resp.Body.Close() } } Logger的运行
现在让我们执行上面的代码并查看日志记录器的运行情况。
func main() { SetupLogger() simpleHttpGet("www.google.com") simpleHttpGet("http://www.google.com") } 当我们执行上面的代码，我们能看到一个test.log文件被创建，下面的内容会被添加到这个日志文件中。
2019/05/24 01:14:13 Error fetching url www.google.com : Get www.google.com: unsupported protocol scheme "" 2019/05/24 01:14:14 Status Code for http://www.google.com : 200 OK
Go Logger的优势和劣势
优势
它最大的优点是使用非常简单。我们可以设置任何io.Writer作为日志记录输出并向其发送要写入的日志。
劣势
仅限基本的日志级别
只有一个Print选项。不支持INFO/DEBUG等多个级别。
对于错误日志，它有fatal和Panic
- Fatal日志通过调用
os.Exit(1)来结束程序 - Panic日志在写入日志消息之后抛出一个panic
- 但是它缺少一个ERROR日志级别，这个级别可以在不抛出panic或退出程序的情况下记录错误
缺乏日志格式化的能力——例如记录调用者的函数名和行号，格式化日期和时间格式。等等。
不提供日志切割的能力。
Uber-go Zap日志库
Zap是非常快的、结构化的，分日志级别的Go日志库。
为什么选择Uber-go zap
- 它同时提供了结构化日志记录和printf风格的日志记录
- 它非常的快
根据Uber-go Zap的文档，它的性能比类似的结构化日志包更好——也比标准库更快。 以下是Zap发布的基准测试信息
记录一条消息和10个字段:
| Package | Time | Time % to zap | Objects Allocated |
|---|---|---|---|
| zap | 862 ns/op | +0% | 5 allocs/op |
| zap (sugared) | 1250 ns/op | +45% | 11 allocs/op |
| zerolog | 4021 ns/op | +366% | 76 allocs/op |
| go-kit | 4542 ns/op | +427% | 105 allocs/op |
| apex/log | 26785 ns/op | +3007% | 115 allocs/op |
| logrus | 29501 ns/op | +3322% | 125 allocs/op |
| log15 | 29906 ns/op | +3369% | 122 allocs/op |
记录一个静态字符串，没有任何上下文或printf风格的模板：
| Package | Time | Time % to zap | Objects Allocated |
|---|---|---|---|
| zap | 118 ns/op | +0% | 0 allocs/op |
| zap (sugared) | 191 ns/op | +62% | 2 allocs/op |
| zerolog | 93 ns/op | -21% | 0 allocs/op |
| go-kit | 280 ns/op | +137% | 11 allocs/op |
| standard library | 499 ns/op | +323% | 2 allocs/op |
| apex/log | 1990 ns/op | +1586% | 10 allocs/op |
| logrus | 3129 ns/op | +2552% | 24 allocs/op |
| log15 | 3887 ns/op | +3194% | 23 allocs/op |
安装
运行下面的命令安装zap
go get -u go.uber.org/zap
配置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界面。
var logger *zap.Logger func main() { InitLogger() defer logger.Sync() simpleHttpGet("www.google.com") simpleHttpGet("http://www.google.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)
其中MethodXXX是一个可变参数函数，可以是Info / Error/ Debug / Panic等。每个方法都接受一个消息字符串和任意数量的zapcore.Field场参数。
每个zapcore.Field其实就是一组键值对参数。
我们执行上面的代码会得到如下输出结果：
{"level":"error","ts":1572159218.912792,"caller":"zap_demo/temp.go:25","msg":"Error fetching url..","url":"www.sogo.com","error":"Get www.sogo.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/q1mi/zap_demo/temp.go:25\nmain.main\n\t/Users/q1mi/zap_demo/temp.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:203"} {"level":"info","ts":1572159219.1227388,"caller":"zap_demo/temp.go:30","msg":"Success..","statusCode":"200 OK","url":"http://www.sogo.com"} Sugared Logger
现在让我们使用Sugared Logger来实现相同的功能。
- 大部分的实现基本都相同。
- 惟一的区别是，我们通过调用主logger的
. Sugar()方法来获取一个SugaredLogger。 - 然后使用
SugaredLogger以printf格式记录语句
下面是修改过后使用SugaredLogger代替Logger的代码：
var sugarLogger *zap.SugaredLogger func main() { InitLogger() defer sugarLogger.Sync() simpleHttpGet("www.google.com") simpleHttpGet("http://www.google.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":1572159149.923002,"caller":"logic/temp2.go:27","msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/q1mi/zap_demo/logic/temp2.go:27\nmain.main\n\t/Users/q1mi/zap_demo/logic/temp2.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:203"} {"level":"info","ts":1572159150.192585,"caller":"logic/temp2.go:29","msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"} 你应该注意到的了，到目前为止这两个logger都打印输出JSON结构格式。
在本博客的后面部分，我们将更详细地讨论SugaredLogger，并了解如何进一步配置它。
定制logger
将日志写入文件而不是终端
我们要做的第一个更改是把日志写入
相关内容
- golang gorm实现get请求查询案例测试_Golang_
- golang gorm更新日志执行SQL示例详解_Golang_
- golang gorm开发架构及写插件示例_Golang_
- golang gorm错误处理事务以及日志用法示例_Golang_
- golang gorm的Callbacks事务回滚对象操作示例_Golang_
- Golang协程池gopool设计与实现_Golang_
- golang gorm的预加载及软删硬删的数据操作示例_Golang_
- golang gorm的关系关联实现示例_Golang_
- golang gorm模型结构体的定义示例_Golang_
- Go语言学习之循环语句使用详解_Golang_
