golang高性能日志库zap

最新推荐文章于 2024-07-08 15:17:26 发布

kuokay

最新推荐文章于 2024-07-08 15:17:26 发布

阅读量955

点赞数 1

分类专栏： GO语言文章标签： golang

本文链接：https://blog.csdn.net/qq_45066628/article/details/118965447

版权

GO语言专栏收录该内容

36 篇文章 8 订阅

订阅专栏

简介

zap是uber开源的Go高性能日志库

为什么选择Uber-go zap

在介绍Uber-go的zap包之前，让我们先看看Go语言提供的基本日志功能。Go语言提供的默认日志包是Go Logger：https://golang.org/pkg/log/

Go Logger的优势和劣势

优势:
它最大的优点是使用非常简单。我们可以设置任何io.Writer作为日志记录输出并向其发送要写入的日志。
劣势

仅限基本的日志级别
只有一个Print选项。不支持INFO/DEBUG等多个级别。
对于错误日志，它有Fatal和Panic
Fatal日志通过调用os.Exit(1)来结束程序
Panic日志在写入日志消息之后抛出一个panic
但是它缺少一个ERROR日志级别，这个级别可以在不抛出panic或退出程序的情况下记录错误
缺乏日志格式化的能力——例如记录调用者的函数名和行号，格式化日期和时间格式。等等。
不提供日志切割的能力。

示例代码：

func SetupLogger() {
    logFileLocation, _ := os.OpenFile("/Users/q1mi/test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
    log.SetOutput(logFileLocation)
}

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()
    }
}

func main() {
    SetupLogger()
    simpleHttpGet("www.google.com")
    simpleHttpGet("http://www.google.com")
}

Uber-go Zap:https://github.com/uber-go/zap是非常快的、结构化的，分日志级别的Go日志库。
它同时提供了结构化日志记录和printf风格的日志记录

根据Uber-go Zap的文档，它的性能比类似的结构化日志包更好——也比标准库更快。以下是Zap发布的基准测试信息。

记录一条消息和10个字段:
在这里插入图片描述
记录一个静态字符串，没有任何上下文或printf风格的模板：

快速上手

安装：

go get -u go.uber.org/zap

配置Zap Logger

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

在性能很好但不是很关键的上下文中，使用SugaredLogger。
在每一微秒和每一次内存分配都很重要的上下文中，使用Logger。

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()
    }
}

{"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

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

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"}

将日志写入文件

我们将使用zap.New(…)方法来手动传递所有配置，而不是使用像zap.NewProduction()这样的预置方法来创建logger。

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

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

Encoder:编码器(如何写入日志)。我们将使用开箱即用的NewJSONEncoder()，并使用预先设置的ProductionEncoderConfig()。
go zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
WriterSyncer ：指定日志将写到哪里去。我们使用zapcore.AddSync()函数并且将打开的文件句柄传进去。
go file, _ := os.Create("./test.log") writeSyncer := zapcore.AddSync(file)
Log Level：哪种级别的日志将被写入。

我们将修改上述部分中的Logger代码，并重写InitLogger()方法。其余方法—main() /SimpleHttpGet()保持不变。

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)
}

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

{"level":"debug","ts":1572160754.994731,"msg":"Trying to hit GET request for www.sogo.com"}
{"level":"error","ts":1572160754.994982,"msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\""}
{"level":"debug","ts":1572160754.994996,"msg":"Trying to hit GET request for http://www.sogo.com"}
{"level":"info","ts":1572160757.3755069,"msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"}

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

return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())

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

1.572161051846623e+09   debug   Trying to hit GET request for www.sogo.com
1.572161051846828e+09   error   Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
1.5721610518468401e+09  debug   Trying to hit GET request for http://www.sogo.com
1.572161052068744e+09   info    Success! statusCode = 200 OK for URL http://www.sogo.com

使用Lumberjack进行日志切割归档:https://github.com/natefinch/lumberjack

kuokay

关注

1
点赞
踩
4

收藏

觉得还不错? 一键收藏
打赏
3
评论
golang高性能日志库zap

简介zap是uber开源的Go高性能日志库为什么选择Uber-go zap在介绍Uber-go的zap包之前，让我们先看看Go语言提供的基本日志功能。Go语言提供的默认日志包是Go Logger：https://golang.org/pkg/log/Go Logger的优势和劣势优势:它最大的优点是使用非常简单。我们可以设置任何io.Writer作为日志记录输出并向其发送要写入的日志。劣势仅限基本的日志级别只有一个Print选项。不支持INFO/DEBUG等多个级别。对于错误日志，它有
复制链接

扫一扫