golang結構化日志slog的用法簡介

更新時間：2023年09月17日 08:32:02 作者：洛天楓

日志是任何軟件的重要組成部分,Go?提供了一個內置日志包（slog）,在本文中,小編將簡單介紹一下slog包的功能以及如何在?Go?應用程序中使用它,感興趣的可以了解下

日志是任何軟件的重要組成部分，Go 提供了一個內置日志包（slog）。然而，隨著應用的復雜性不斷增加，對結構化日志的需求也越來越明顯。結構化日志允許開發(fā)人員以結構化格式記錄數(shù)據(jù)，便于日志聚合工具進行解析和分析，目前業(yè)界使用比較多的是：zap。

在本文中，我將簡單介紹 slog 包、它的功能以及如何在 Go 應用程序中使用它。

什么是 slog

slog 提供結構化日志記錄，其中的日志記錄包括一條消息、level 和其他各種以鍵值對表示的屬性。

使用

最新的1.21版本引入了slog。要在 Go 項目中使用slog，可以通過以下方式導入它：

import "log/slog"

這里寫一個非常簡單的例子：

func main() {
	slog.Info("hello, world!", "coding", "happy")
}

輸出：

2023/09/15 13:42:27 INFO hello, world! coding=happy

功能

slog 提供了許多有用的功能，使其成為 Go 的強大日志包。以下是其中的一些主要功能：

結構化日志
嚴重級別日志
分組日志
自定義處理

結構化日志

slog 默認提供兩種方式：

TextHandler
JSONHandler

我們寫一下使用這兩個方式的例子：

func main() {
	textHandler := slog.NewTextHandler(os.Stdout, nil)
	textLogger := slog.New(textHandler)
	textLogger.Info("TextDemo",
		slog.String("app-version", "v0.0.1"),
		slog.Int("release-version", 1),
	)
	jsonHandler := slog.NewJSONHandler(os.Stdout, nil)
	jsonLogger := slog.New(jsonHandler)
	jsonLogger.Info("JsonDemo",
		slog.String("app-version", "v0.0.1"),
		slog.Int("release-version", 1),
	)
}

輸出為：

time=2023-09-15T13:48:37.424+08:00 level=INFO msg=TextDemo app-version=v0.0.1 release-version=1
{"time":"2023-09-15T13:48:37.4647782+08:00","level":"INFO","msg":"JsonDemo","app-version":"v0.0.1","release-version":1}

從上面我們可以看到，代碼中使用了類似slog.String的方法，slog提供了指定屬性的功能。有多種類型的屬性可供選擇：

slog.String：字符串屬性。
slog.Int：整數(shù)屬性。
slog.Float64：浮點屬性。
slog.Bool：布爾屬性。
slog.Duration：持續(xù)時間屬性。
slog.Time：時間屬性。
slog.Group：組屬性，可用于將相關屬性分組

func main() {
	jsonHandler := slog.NewJSONHandler(os.Stdout, nil)
	jsonLogger := slog.New(jsonHandler)
	jsonLogger.Info(
		"attributes",
		slog.String("version", "1.0.0"),
		slog.Int("app-version", 1),
		slog.Float64("point-value", 1.2),
		slog.Bool("status", true),
		slog.Duration("duration", time.Hour*1),
		slog.Time("time", time.Now()),
		slog.Group(
			"request",
			slog.String("path", "<https://example.com>"),
			slog.String("method", "get"),
		),
	)
}

對應的輸出，我已經將其格式化了：

{
  "time": "2023-09-15T13:53:43.8848272+08:00",
  "level": "INFO",
  "msg": "attributes",
  "version": "1.0.0",
  "app-version": 1,
  "point-value": 1.2,
  "status": true,
  "duration": 3600000000000,
  "time": "2023-09-15T13:53:43.8848272+08:00",
  "request": {
    "path": "<https://example.com>",
    "method": "get"
  }
}

嚴重級別日志

這允許我們記錄不同嚴重程度的信息。slog 默認提供四個日志級別，每個級別都有一個整數(shù)值：

DEBUG（-4）
INFO（0）
WARN（4）
ERROR（8）

例子：

func main() {
	jsonHandler := slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
		Level: slog.LevelDebug,
	})
	jsonLogger := slog.New(jsonHandler)
	jsonLogger.Debug("Hello, world!")
	jsonLogger.Info("Hello, world!")
	jsonLogger.Warn("Hello, world!")
	jsonLogger.Error("Hello, world!")
}

NOTE: 記得在NewHandler時設置級別。

分組日志

分組日志指的是將日志信息歸類為邏輯組或類別的做法。Slog 通過使用與日志記錄相關聯(lián)的屬性或鍵值對來支持分組日志記錄。

例子：

func main() {
	jsonHandler := slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
		Level: slog.LevelDebug,
	})
	jsonLogger := slog.New(jsonHandler).WithGroup("request")
	jsonLogger.Info("",
		slog.String("url", "<https://example.com>"),
		slog.String("method", "GET"),
		slog.Int("response-code", 200),
	)
}

這里有個比較好的實踐：

在 http 服務的 middleware 中定義一個 request 組的 logger，會一些 4xx、5xx等請求的一些信息打印出來。
而普通業(yè)務的話，我們又可以使用一個 service 組的 logger

自定義處理

slog 能夠創(chuàng)建自定義handler，將日志信息寫入不同的目的地，如文件、數(shù)據(jù)庫或外部服務。

slog 提供的處理程序接口定義了自定義處理程序必須實現(xiàn)的方法。處理程序接口有四個方法:

type Handler interface {
    Enabled(Level) bool
    Handle(Record) error
    WithAttrs([]Attr) Handler
    WithGroup(string) Handler
}

下面舉例說明如何創(chuàng)建一個將日志信息寫入文件的自定義handler:

type FileHandler struct {
	file *os.File
}
func NewFileHandler(filename string) (*FileHandler, error) {
	file, err := os.OpenFile(filename, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
	if err != nil {
		return nil, err
	}
	return &FileHandler{file}, nil
}
func (h *FileHandler) Enabled(_ context.Context, level slog.Level) bool {
	return true
}
func (h *FileHandler) Handle(_ context.Context, record slog.Record) error {
	_, err := h.file.WriteString(record.Message + "\n")
	return err
}
func (h *FileHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
	return h
}
func (h *FileHandler) WithGroup(name string) slog.Handler {
	return h
}
func (h *FileHandler) Close() error {
	return h.file.Close()
}
func main() {
	fileHandler, err := NewFileHandler("log.log")
	if err != nil {
		panic(err)
	}
	defer fileHandler.Close()
	logger := slog.New(fileHandler)
	logger.Info("Hello, world!")
	logger.Debug("Debugging errors")
}

這個時候運行程序時，控制臺就不會有對應的日志輸出了，而是輸出到對應文件上：