Go日志之日志库讲解

 更新时间:2026年04月21日 09:12:17   作者:爱吃牛肉的大老虎  
本文介绍了Go语言中最优秀的日志库,包括Zap、log/slog、Logrus和Zerolog,它们都提供了结构化日志记录、自定义日志级别、输出目标等特性,感兴趣的可以了解一下

1.1 引言

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

本文将介绍Go语言中最流行和最优秀的日志库,并给出每个库的使用示例代码

1.2 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"),
 )
}

1.3 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)来处理不同级别或条件的日志信息,如过滤、分割、彩色等。
    v可以使用条目(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”}

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

1.5 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日志之日志库讲解的文章就介绍到这了,更多相关Go 日志库内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Go语言学习教程之反射的示例详解

    Go语言学习教程之反射的示例详解

    这篇文章主要通过记录对reflect包的简单使用,来对反射有一定的了解。文中的示例代码讲解详细,对我们学习Go语言有一定帮助,需要的可以参考一下
    2022-09-09
  • Go语言ORM包中使用worm构造查询条件的实例详解

    Go语言ORM包中使用worm构造查询条件的实例详解

    worm是一款方便易用的Go语言ORM库。worm支Model方式(持结构体字段映射)、原生SQL以及SQLBuilder三种模式来操作数据库,并且Model方式、原生SQL以及SQLBuilder可混合使用,本文通过一些例子来说明如何使用worm来构造查询条件,感兴趣的朋友一起看看吧
    2022-07-07
  • Go语言用map实现堆栈功能的方法

    Go语言用map实现堆栈功能的方法

    这篇文章主要介绍了Go语言用map实现堆栈功能的方法,实例分析了Go语言使用map操作堆栈的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-02-02
  • Golang文件操作之读取与写入方法全攻略

    Golang文件操作之读取与写入方法全攻略

    本文详细介绍了在Go语言中进行文件操作的方法,包括文件的创建、打开、读取、写入和关闭等,解析了使用os、bufio和io包进行高效文件操作的技巧,并提供了错误处理与性能优化的建议,以帮助开发者有效管理文件资源并提升应用性能,需要的朋友可以参考下
    2024-11-11
  • Golang实现自己的Redis(有序集合跳表)实例探究

    Golang实现自己的Redis(有序集合跳表)实例探究

    这篇文章主要为大家介绍了Golang实现自己的Redis(有序集合跳表)实例探究,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • GoFrame框架garray并发安全数组使用开箱体验

    GoFrame框架garray并发安全数组使用开箱体验

    这篇文章主要介绍了GoFrame框架garray并发安全数组使用开箱体验,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • 浅谈golang并发操作变量安全的问题

    浅谈golang并发操作变量安全的问题

    这篇文章主要介绍了浅谈golang并发操作变量安全的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Golang实现数据结构Stack(堆栈)的示例详解

    Golang实现数据结构Stack(堆栈)的示例详解

    在计算机科学中,stack(栈)是一种基本的数据结构,它是一种线性结构,具有后进先出(Last In First Out)的特点。本文将通过Golang实现堆栈,需要的可以参考一下
    2023-04-04
  • GoLang切片并发安全解决方案详解

    GoLang切片并发安全解决方案详解

    这篇文章主要介绍了GoLang切片并发安全问题的解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2022-10-10
  • Go之interface的具体使用

    Go之interface的具体使用

    这篇文章主要介绍了Go之interface的具体使用,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03

最新评论