盘点 Go 语言的那些日志库:你用了哪个?

开发 前端
在本文中,我们介绍了Go语言中最流行和最优秀的日志库,并给出了每个库的使用示例代码。这些日志库都有各自的优点和特点,可以根据你的需求和喜好来选择合适的日志库。

大家好,我是站长 polarisxu。

Go语言是一种高性能、简洁、并发友好的编程语言,广泛用于开发各种应用程序,如网络服务、微服务、云计算、区块链等。Go语言的标准库提供了一个基本的日志包(log),可以用于记录简单的日志信息,如时间、级别、消息等。但是,如果你需要更多的功能和灵活性,例如结构化日志、日志旋转、日志钩子、日志格式化等,那么你可能需要使用第三方的日志库。

在本文中,我们将介绍Go语言中最流行和最优秀的日志库,并给出每个库的使用示例代码。我们将按照以下的大纲来介绍这些日志库:

  • Zap
  • log/slog
  • Logrus
  • Zerolog
  • Glog

Zap

Zap 是一个快速、结构化、分级和可扩展的日志库,由Uber开发和维护。Zap提供了两种不同的API:SugaredLogger和Logger。SugaredLogger支持结构化和非结构化的日志记录,但是牺牲了一些性能。Logger只支持结构化的日志记录,但是具有更高的性能和更低的内存分配。

Zap还提供了一些有用的特性,如:

  • 可以自定义日志级别、输出目标、编码器(JSON或控制台)、时间格式等。
  • 可以使用字段(Fields)来添加结构化的上下文信息,如键值对。
  • 可以使用钩子(Hooks)来在每次写入日志时执行一些操作,如发送邮件、写入数据库等。
  • 可以使用取样器(Sampler)来限制每秒写入的日志数量,以减少性能开销。
  • 可以使用核心(Core)来组合多个输出目标和编码器。

以下是一个使用Zap的示例代码:

package main

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

func main() {
 // 创建一个 Logger
 logger, err := zap.NewDevelopment()
 if err != nil {
  panic(err)
 }
 defer logger.Sync()
 sugar := logger.Sugar()

 // 使用SugaredLogger记录非结构化的日志
 sugar.Infow("This is a structured log",
  "key1", "value1",
  "key2", "value2",
 )

 // 使用SugaredLogger记录结构化的日志
 sugar.Infof("This is an unstructured log: %s", "hello world")

 // 创建一个Logger
 logger, err = zap.NewProduction()
 if err != nil {
  panic(err)
 }
 defer logger.Sync()

 // 使用Logger记录结构化的日志
 logger.Info("This is a structured log",
  zap.String("key1", "value1"),
  zap.String("key2", "value2"),
 )

 // 使用Logger记录错误级别的日志,并添加堆栈跟踪信息
 logger.Error("This is an error log",
  zap.Error(err),
  zap.Stack("stack"),
 )
}

log/slog

log/slog是Go 1.21中引入的一个新的结构化日志库,它与标准库的log包兼容,但提供了更多的功能和灵活性。log/slog定义了一个类型,Logger,用于记录不同级别和格式的日志信息。每个Logger都关联一个Handler,用于处理日志记录。log/slog还提供了一个默认的Logger,可以通过顶级函数(如Info和Error)来使用,它们会调用相应的Logger方法。该默认Logger将日志信息写入标准错误,并在每条日志信息前添加日期和时间。

log/slog的日志记录由以下几个部分组成:

  • 时间:日志记录发生的时间,可以是本地时间或UTC时间。
  • 级别:日志记录的严重程度,可以是预定义的四个级别之一(Debug、Info、Warn、Error),也可以是自定义的整数值。
  • 消息:日志记录的主要内容,通常是一个简短的描述性字符串。
  • 属性:日志记录的额外信息,以键值对的形式表示,键是字符串,值可以是任意类型。

例如,以下代码:

package main

import (
 "log/slog"
 "os"
)

func main() {
 slog.Info("hello, world", "user", os.Getenv("USER"))
}

会产生以下输出:

2023/09/09 16:27:19 INFO hello, world user=polarisxu

其中,2023/09/09 16:27:19是时间,INFO是级别,hello, world是消息,user=polarisxu是属性。

log/slog还提供了一些有用的特性,如:

  • 可以自定义日志级别、输出目标、格式器(JSON或文本)、时间戳等。
  • 可以使用字段(Fields)来添加结构化的上下文信息,如键值对。
  • 可以使用处理器(Handler)来处理不同级别或条件的日志信息,如过滤、分割、彩色等。
  • 可以使用条目(Entry)来记录带有字段的日志信息,或者使用WithFields、WithTime、WithError等方法来创建带有字段的条目。
  • 可以使用日志级别函数(如Info、Warn、Error等)来记录不同级别的日志信息,或者使用Log或Print等方法来记录默认级别的日志信息。

以下是一个使用log/slog的示例代码:

package main

import (
 "log/slog"
 "os"
)

func main() {
 // 创建一个JSON处理器
 jsonHandler := slog.NewJSONHandler(os.Stdout, nil)

 // 创建一个文本处理器
 textHandler := slog.NewTextHandler(os.Stderr, nil)

 // 创建一个文本 Logger
 textLogger := slog.New(textHandler)

 // 创建一个 JSON Logger
 jsonLogger := slog.New(jsonHandler)

 // 使用Logger记录结构化的日志信息
 textLogger.Info("hello, world", "user", os.Getenv("USER"))

 // 使用Logger记录结构化的日志信息
 jsonLogger.Info("hello, world", "user", os.Getenv("USER"))
}

该程序会在标准错误上输出文本格式的日志信息:

time=2023-09-09T16:27:19.000-05:00 level=INFO msg=hello, world user=polarisxu

然后在标准输出上输出JSON格式的日志信息:

{"time":"2023-09-09T16:27:19.000000000-05:00","level":"INFO","msg":"hello","user":"polarisxu"}

Logrus

Logrus是一个结构化、分级、可扩展和兼容标准库log包的日志库,由Sirupsen开发和维护。Logrus提供了一个简单而强大的API,可以用于记录不同级别和格式的日志信息。

Logrus也提供了一些有用的特性,如:

  • 可以自定义日志级别、输出目标、格式器(JSON或文本)、时间戳等。
  • 可以使用字段(Fields)来添加结构化的上下文信息,如键值对。
  • 可以使用钩子(Hooks)来在每次写入日志时执行一些操作,如发送邮件、写入数据库等。
  • 可以使用条目(Entry)来记录带有字段的日志信息,或者使用WithFields、WithTime、WithError等方法来创建带有字段的条目。
  • 可以使用日志级别函数(如Info、Warn、Error等)来记录不同级别的日志信息,或者使用Log或Print等方法来记录默认级别的日志信息。

以下是一个使用Logrus的示例代码:

package main

import (
 "os"

 "github.com/sirupsen/logrus"
)

func main() {
 // 创建一个Logrus实例
 log := logrus.New()

 // 设置日志级别为Debug
 log.SetLevel(logrus.DebugLevel)

 // 设置输出目标为标准输出
 log.SetOutput(os.Stdout)

 // 设置格式器为JSON
 log.SetFormatter(&logrus.JSONFormatter{})

 // 使用Fields添加结构化的上下文信息
 log.WithFields(logrus.Fields{
  "key1": "value1",
  "key2": "value2",
 }).Info("This is a structured log")

 // 使用Entry记录带有字段的日志信息
 entry := log.WithFields(logrus.Fields{
  "key3": "value3",
  "key4": "value4",
 })
 entry.Warn("This is another structured log")

 // 使用日志级别函数记录不同级别的日志信息
 log.Debug("This is a debug log")
 log.Info("This is an info log")
 log.Warn("This is a warn log")
 log.Error("This is an error log")
 log.Fatal("This is a fatal log")
 log.Panic("This is a panic log")

 // 使用Log或Print等方法记录默认级别的日志信息
 log.Log(logrus.InfoLevel, "This is a log with level")
 log.Print("This is a print log")
}

Zerolog

Zerolog是一个快速、简单、零内存分配的结构化日志库,由rs开发和维护。Zerolog提供了一个流式(Fluent)的API,可以用于记录不同级别和格式的日志信息。

Zerolog也提供了一些有用的特性,如:

  • 可以自定义日志级别、输出目标、编码器(JSON或控制台)、时间格式等。
  • 可以使用字段(Fields)来添加结构化的上下文信息,如键值对。
  • 可以使用钩子(Hooks)来在每次写入日志时执行一些操作,如发送邮件、写入数据库等。
  • 可以使用取样器(Sampler)来限制每秒写入的日志数量,以减少性能开销。
  • 可以使用上下文(Context)来创建带有字段的日志记录器,或者使用With、Dict等方法来添加字段。

以下是一个使用Zerolog的示例代码:

package main

import (
 "os"

 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
)

func main() {
 // 设置日志级别为Debug
 zerolog.SetGlobalLevel(zerolog.DebugLevel)

 // 设置输出目标为标准输出
 log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout})

 // 使用Fields添加结构化的上下文信息
 log.Info().
  Str("key1", "value1").
  Str("key2", "value2").
  Msg("This is a structured log")

 // 使用Context创建带有字段的日志记录器
 sublogger := log.With().
  Str("key3", "value3").
  Logger()

 sublogger.Warn().
  Str("key4", "value4").
  Msg("This is another structured log")

 // 使用日志级别函数记录不同级别的日志信息
 log.Debug().Msg("This is a debug log")
 log.Info().Msg("This is an info log")
 log.Warn().Msg("This is a warn log")
 log.Error().Msg("This is an error log")
 log.Fatal().Msg("This is a fatal log")
 log.Panic().Msg("This is a panic log")
}

总结

在本文中,我们介绍了Go语言中最流行和最优秀的日志库,并给出了每个库的使用示例代码。这些日志库都有各自的优点和特点,可以根据你的需求和喜好来选择合适的日志库。

责任编辑:武晓燕 来源: polarisxu
相关推荐

2022-11-28 11:45:30

Go应用场景

2023-02-13 00:24:37

Go语言日志库

2021-12-23 23:11:37

C语言编程工具

2022-10-24 09:57:02

runeGo语言

2017-12-27 11:59:52

2023-12-06 14:23:24

2021-03-01 21:59:25

编程语言GoCX

2021-03-01 18:35:18

Go语言虚拟机

2024-04-01 08:05:27

Go开发Java

2019-04-24 09:20:58

Go语言编程语言

2014-04-28 09:18:17

创业移动互联网Linux入门教程

2018-01-08 15:13:15

httphttpsSSL证书

2024-02-26 19:38:20

GitHubGo库Golang

2014-04-24 10:48:27

Go语言基础实现

2021-07-08 15:51:19

日志分析系统

2023-04-02 23:13:07

Go语言bufio

2022-02-14 08:04:02

Go语法糖编译器

2017-04-20 14:58:16

2017-09-26 11:06:15

数据库索引查询

2023-04-18 08:27:16

日志级别日志包
点赞
收藏

51CTO技术栈公众号