Go slog

2024-06-02 523 words 2 minutes

Contents

slog 结构化日志

参考链接：https://betterstack.com/community/guides/logging/logging-in-go/#customizing-the-default-logger

1、下载

go get golang.org/x/exp/slog@latest

2、使用

1）简单实用

package main

import (
    "errors"

    "golang.org/x/exp/slog"
)

func main() {
    slog.Debug("Debug message")
    slog.Info("Info message")
    slog.Warn("Warning message")
    slog.Error("Error message")
}

output

2023/03/15 12:55:56 INFO Info message
2023/03/15 12:55:56 WARN Warning message
2023/03/15 12:55:56 ERROR Error message

2）json格式输出

package main

import (
    "errors"
    "os"

    "golang.org/x/exp/slog"
)

func main() {
    logger := slog.New(slog.NewJSONHandler(os.Stdout))
    logger.Debug("Debug message")
    logger.Info("Info message")
    logger.Warn("Warning message")
    logger.Error("Error message")
}

output

{"time":"2023-03-15T12:59:22.227408691+01:00","level":"INFO","msg":"Info message"}
{"time":"2023-03-15T12:59:22.227468972+01:00","level":"WARN","msg":"Warning message"}
{"time":"2023-03-15T12:59:22.227472149+01:00","level":"ERROR","msg":"Error message","!BADKEY":"an error"}

3）自己定义

package sugar

import (
	"os"
	"path/filepath"

	"golang.org/x/exp/slog"
)

type Log struct {
	Level string // 日志级别  string // 日志文件存放路径,如果为空，则输出到控制台
	Type  string // 日志类型，支持 txt 和 json ，默认txt
	Short bool   // 以包/文件:行号 显示短路径，不显示全路径
}

type LogOptions func(*Log)

func WithLevel(level string) LogOptions {
	return func(lg *Log) {
		lg.Level = level
	}
}

func WithType(tp string) LogOptions {
	return func(lg *Log) {
		lg.Type = tp
	}
}

func WithShort(short bool) LogOptions {
	return func(lg *Log) {
		lg.Short = short
	}
}

// LevelToZapLevel  转换日志级别
func LevelToSlogLevel(level string) slog.Level {
	switch level {
	case "debug", "DEBUG":
		return slog.LevelDebug
	case "info", "INFO":
		return slog.LevelInfo
	case "warn", "WARN", "WARNING":
		return slog.LevelWarn
	case "error", "ERROR":
		return slog.LevelError
	default:
		return slog.LevelInfo
	}

}

func NewSlog(lg *Log) *slog.Logger {

	replace := func(groups []string, a slog.Attr) slog.Attr {

		// Remove the directory from the source's filename.
		if a.Key == slog.SourceKey && lg.Short {
			a.Value = slog.StringValue(filepath.Base(a.Value.String()))
		}
		return a
	}
	opts := slog.HandlerOptions{
		AddSource:   true,
		Level:       LevelToSlogLevel(lg.Level),
		ReplaceAttr: replace,
	}

	var log *slog.Logger
	if lg.Type == "json" {
		log = slog.New(opts.NewJSONHandler(os.Stdout))
	} else {
		log = slog.New(opts.NewTextHandler(os.Stdout))
	}
	return log
}

func New(options ...LogOptions) *slog.Logger {
	// 默认值的设定
	lg := &Log{
		Level: "info",
		Type:  "txt",
		Short: true,
	}

	// 遍历可选参数，然后分别调用匿名函数，将连接对象指针传入，进行修改
	for _, opt := range options {
		// 遍历调用函数，进行数据修改
		opt(lg)
	}
	return NewSlog(lg)
}