1.1 引言

Go語(yǔ)言是一種高性能、簡(jiǎn)潔、并發(fā)友好的編程語(yǔ)言，廣泛用于開(kāi)發(fā)各種應(yīng)用程序，如網(wǎng)絡(luò)服務(wù)、微服務(wù)、云計(jì)算、區(qū)塊鏈等。Go語(yǔ)言的標(biāo)準(zhǔn)庫(kù)提供了一個(gè)基本的日志包（log），可以用于記錄簡(jiǎn)單的日志信息，如時(shí)間、級(jí)別、消息等。但是，如果需要更多的功能和靈活性，例如結(jié)構(gòu)化日志、日志旋轉(zhuǎn)、日志鉤子、日志格式化等，那么可能需要使用第三方的日志庫(kù)。

本文將介紹Go語(yǔ)言中最流行和最優(yōu)秀的日志庫(kù)，并給出每個(gè)庫(kù)的使用示例代碼

1.2 Zap

Zap 是一個(gè)快速、結(jié)構(gòu)化、分級(jí)和可擴(kuò)展的日志庫(kù)，由Uber開(kāi)發(fā)和維護(hù)。Zap提供了兩種不同的API：SugaredLogger和Logger。SugaredLogger支持結(jié)構(gòu)化和非結(jié)構(gòu)化的日志記錄，但是犧牲了一些性能。Logger只支持結(jié)構(gòu)化的日志記錄，但是具有更高的性能和更低的內(nèi)存分配。

Zap還提供了一些有用的特性，如：

• 可以自定義日志級(jí)別、輸出目標(biāo)、編碼器（JSON或控制臺(tái)）、時(shí)間格式等。
• 可以使用字段（Fields）來(lái)添加結(jié)構(gòu)化的上下文信息，如鍵值對(duì)。
• 可以使用鉤子（Hooks）來(lái)在每次寫(xiě)入日志時(shí)執(zhí)行一些操作，如發(fā)送郵件、寫(xiě)入數(shù)據(jù)庫(kù)等。
• 可以使用取樣器（Sampler）來(lái)限制每秒寫(xiě)入的日志數(shù)量，以減少性能開(kāi)銷(xiāo)。
• 可以使用核心（Core）來(lái)組合多個(gè)輸出目標(biāo)和編碼器。

以下是一個(gè)使用Zap的示例代碼：

package main
import (
 "go.uber.org/zap"
)
func main() {
 // 創(chuàng)建一個(gè) Logger
 logger, err := zap.NewDevelopment()
 if err != nil {
  panic(err)
 }
 defer logger.Sync()
 sugar := logger.Sugar()
 // 使用SugaredLogger記錄非結(jié)構(gòu)化的日志
 sugar.Infow("This is a structured log",
  "key1", "value1",
  "key2", "value2",
 )
 // 使用SugaredLogger記錄結(jié)構(gòu)化的日志
 sugar.Infof("This is an unstructured log: %s", "hello world")
 // 創(chuàng)建一個(gè)Logger
 logger, err = zap.NewProduction()
 if err != nil {
  panic(err)
 }
 defer logger.Sync()
 // 使用Logger記錄結(jié)構(gòu)化的日志
 logger.Info("This is a structured log",
  zap.String("key1", "value1"),
  zap.String("key2", "value2"),
 )
 // 使用Logger記錄錯(cuò)誤級(jí)別的日志，并添加堆棧跟蹤信息
 logger.Error("This is an error log",
  zap.Error(err),
  zap.Stack("stack"),
 )
}

1.3 log/slog

log/slog 是 Go 1.21 中引入的一個(gè)新的結(jié)構(gòu)化日志庫(kù)，它與標(biāo)準(zhǔn)庫(kù)的log包兼容，但提供了更多的功能和靈活性。log/slog定義了一個(gè)類(lèi)型 Logger，用于記錄不同級(jí)別和格式的日志信息。每個(gè) Logger 都關(guān)聯(lián)一個(gè)Handler，用于處理日志記錄。log/slog還提供了一個(gè)默認(rèn)的 Logger，可以通過(guò)頂級(jí)函數(shù)（如Info和Error）來(lái)使用，它們會(huì)調(diào)用相應(yīng)的Logger方法。該默認(rèn)Logger將日志信息寫(xiě)入標(biāo)準(zhǔn)錯(cuò)誤，并在每條日志信息前添加日期和時(shí)間。

log/slog的日志記錄由以下幾個(gè)部分組成：

• 時(shí)間：日志記錄發(fā)生的時(shí)間，可以是本地時(shí)間或UTC時(shí)間。
• 級(jí)別：日志記錄的嚴(yán)重程度，可以是預(yù)定義的四個(gè)級(jí)別之一（Debug、Info、Warn、Error），也可以是自定義的整數(shù)值。
• 消息：日志記錄的主要內(nèi)容，通常是一個(gè)簡(jiǎn)短的描述性字符串。
• 屬性：日志記錄的額外信息，以鍵值對(duì)的形式表示，鍵是字符串，值可以是任意類(lèi)型。

例如，以下代碼：

package main

import (
 "log/slog"
 "os"
)

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

會(huì)產(chǎn)生以下輸出：

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

其中，2023/09/09 16:27:19是時(shí)間，INFO是級(jí)別，hello, world是消息，user=polarisxu是屬性。

log/slog還提供了一些有用的特性，如：

• 可以自定義日志級(jí)別、輸出目標(biāo)、格式器（JSON或文本）、時(shí)間戳等。
• 可以使用字段（Fields）來(lái)添加結(jié)構(gòu)化的上下文信息，如鍵值對(duì)。
• 可以使用處理器（Handler）來(lái)處理不同級(jí)別或條件的日志信息，如過(guò)濾、分割、彩色等。
  v可以使用條目（Entry）來(lái)記錄帶有字段的日志信息，或者使用WithFields、WithTime、WithError等方法來(lái)創(chuàng)建帶有字段的條目。
• 可以使用日志級(jí)別函數(shù)（如Info、Warn、Error等）來(lái)記錄不同級(jí)別的日志信息，或者使用Log或Print等方法來(lái)記錄默認(rèn)級(jí)別的日志信息。

以下是一個(gè)使用log/slog的示例代碼：

package main
import (
 "log/slog"
 "os"
)
func main() {
 // 創(chuàng)建一個(gè)JSON處理器
 jsonHandler := slog.NewJSONHandler(os.Stdout, nil)
 // 創(chuàng)建一個(gè)文本處理器
 textHandler := slog.NewTextHandler(os.Stderr, nil)
 // 創(chuàng)建一個(gè)文本 Logger
 textLogger := slog.New(textHandler)
 // 創(chuàng)建一個(gè) JSON Logger
 jsonLogger := slog.New(jsonHandler)
 // 使用Logger記錄結(jié)構(gòu)化的日志信息
 textLogger.Info("hello, world", "user", os.Getenv("USER"))
 // 使用Logger記錄結(jié)構(gòu)化的日志信息
 jsonLogger.Info("hello, world", "user", os.Getenv("USER"))
}

該程序會(huì)在標(biāo)準(zhǔn)錯(cuò)誤上輸出文本格式的日志信息：

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

然后在標(biāo)準(zhǔn)輸出上輸出JSON格式的日志信息：

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

1.4 Logrus

Logrus是一個(gè)結(jié)構(gòu)化、分級(jí)、可擴(kuò)展和兼容標(biāo)準(zhǔn)庫(kù)log包的日志庫(kù)，由Sirupsen開(kāi)發(fā)和維護(hù)。Logrus提供了一個(gè)簡(jiǎn)單而強(qiáng)大的API，可以用于記錄不同級(jí)別和格式的日志信息。

Logrus也提供了一些有用的特性，如：

• 可以自定義日志級(jí)別、輸出目標(biāo)、格式器（JSON或文本）、時(shí)間戳等。
• 可以使用字段（Fields）來(lái)添加結(jié)構(gòu)化的上下文信息，如鍵值對(duì)。
• 可以使用鉤子（Hooks）來(lái)在每次寫(xiě)入日志時(shí)執(zhí)行一些操作，如發(fā)送郵件、寫(xiě)入數(shù)據(jù)庫(kù)等。
• 可以使用條目（Entry）來(lái)記錄帶有字段的日志信息，或者使用WithFields、WithTime、WithError等方法來(lái)創(chuàng)建帶有字段的條目。
• 可以使用日志級(jí)別函數(shù)（如Info、Warn、Error等）來(lái)記錄不同級(jí)別的日志信息，或者使用Log或Print等方法來(lái)記錄默認(rèn)級(jí)別的日志信息。

以下是一個(gè)使用Logrus的示例代碼：

package main
import (
 "os"
 "github.com/sirupsen/logrus"
)
func main() {
 // 創(chuàng)建一個(gè)Logrus實(shí)例
 log := logrus.New()
 // 設(shè)置日志級(jí)別為Debug
 log.SetLevel(logrus.DebugLevel)
 // 設(shè)置輸出目標(biāo)為標(biāo)準(zhǔn)輸出
 log.SetOutput(os.Stdout)
 // 設(shè)置格式器為JSON
 log.SetFormatter(&logrus.JSONFormatter{})
 // 使用Fields添加結(jié)構(gòu)化的上下文信息
 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")
 // 使用日志級(jí)別函數(shù)記錄不同級(jí)別的日志信息
 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等方法記錄默認(rèn)級(jí)別的日志信息
 log.Log(logrus.InfoLevel, "This is a log with level")
 log.Print("This is a print log")
}

1.5 Zerolog

Zerolog是一個(gè)快速、簡(jiǎn)單、零內(nèi)存分配的結(jié)構(gòu)化日志庫(kù)，由rs開(kāi)發(fā)和維護(hù)。Zerolog 提供了一個(gè)流式（Fluent）的API，可以用于記錄不同級(jí)別和格式的日志信息。

Zerolog也提供了一些有用的特性，如：

• 可以自定義日志級(jí)別、輸出目標(biāo)、編碼器（JSON或控制臺(tái)）、時(shí)間格式等。
• 可以使用字段（Fields）來(lái)添加結(jié)構(gòu)化的上下文信息，如鍵值對(duì)。
• 可以使用鉤子（Hooks）來(lái)在每次寫(xiě)入日志時(shí)執(zhí)行一些操作，如發(fā)送郵件、寫(xiě)入數(shù)據(jù)庫(kù)等。
• 可以使用取樣器（Sampler）來(lái)限制每秒寫(xiě)入的日志數(shù)量，以減少性能開(kāi)銷(xiāo)。
• 可以使用上下文（Context）來(lái)創(chuàng)建帶有字段的日志記錄器，或者使用With、Dict等方法來(lái)添加字段。

以下是一個(gè)使用Zerolog的示例代碼：

package main
import (
 "os"
 "github.com/rs/zerolog"
 "github.com/rs/zerolog/log"
)
func main() {
 // 設(shè)置日志級(jí)別為Debug
 zerolog.SetGlobalLevel(zerolog.DebugLevel)
 // 設(shè)置輸出目標(biāo)為標(biāo)準(zhǔn)輸出
 log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stdout})
 // 使用Fields添加結(jié)構(gòu)化的上下文信息
 log.Info().
  Str("key1", "value1").
  Str("key2", "value2").
  Msg("This is a structured log")
 // 使用Context創(chuàng)建帶有字段的日志記錄器
 sublogger := log.With().
  Str("key3", "value3").
  Logger()
 sublogger.Warn().
  Str("key4", "value4").
  Msg("This is another structured log")
 // 使用日志級(jí)別函數(shù)記錄不同級(jí)別的日志信息
 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")
}

到此這篇關(guān)于Go日志之日志庫(kù)講解的文章就介紹到這了,更多相關(guān)Go 日志庫(kù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論