Go结构化日志记录库log使用指南

Go标准库中的log包虽然简单易用，但功能有限。下面我将介绍几种更强大的结构化日志记录方案，包括标准库log、第三方库logrus和zap的使用方法。

1. 标准库log包基础使用

Go标准库中的log包提供了最基本的日志功能：

package main

import (
	"log"
	"os"
)

func main() {
	// 基本日志输出
	log.Println("这是一条普通日志")
	
	// 设置日志前缀
	log.SetPrefix("MyApp: ")
	
	// 设置日志标志(日期、时间、文件名等)
	log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)
	
	// 输出到文件
	file, err := os.OpenFile("app.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
	if err != nil {
		log.Fatal("无法打开日志文件:", err)
	}
	defer file.Close()
	
	log.SetOutput(file)
	log.Println("这条日志会写入文件")
	
	// 致命错误日志(会调用os.Exit(1))
	// log.Fatal("致命错误")
	
	// 恐慌日志(会抛出panic)
	// log.Panic("恐慌错误")
}

2. 使用logrus进行结构化日志记录

logrus是Go中最流行的日志库之一，支持结构化日志和多种日志级别：

package main

import (
	"github.com/sirupsen/logrus"
	"os"
)

func main() {
	// 创建logrus实例
	log := logrus.New()
	
	// 设置日志级别
	log.SetLevel(logrus.DebugLevel)
	
	// 设置输出格式为JSON
	log.SetFormatter(&logrus.JSONFormatter{})
	
	// 输出到文件
	file, err := os.OpenFile("app.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
	if err == nil {
		log.SetOutput(file)
	} else {
		log.Info("无法写入日志文件，使用标准错误输出")
	}
	
	// 带字段的结构化日志
	log.WithFields(logrus.Fields{
		"event": "user_login",
		"user_id": 12345,
	}).Info("用户登录")
	
	// 不同级别的日志
	log.Debug("调试信息")
	log.Info("普通信息")
	log.Warn("警告信息")
	log.Error("错误信息")
	// log.Fatal("致命错误") // 会退出程序
	// log.Panic("恐慌错误") // 会抛出panic
	
	// 使用预定义字段
	contextLogger := log.WithFields(logrus.Fields{
		"app": "myapp",
		"env": "production",
	})
	contextLogger.Info("带上下文的日志")
}

3. 使用zap进行高性能日志记录

Uber开发的zap库是性能最高的Go日志库之一，特别适合高性能应用：

package main

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

func main() {
	// 配置zap日志编码器
	encoderCfg := zapcore.EncoderConfig{
		TimeKey:        "time",
		LevelKey:      "level",
		NameKey:       "logger",
		CallerKey:     "caller",
		FunctionKey:   zapcore.OmitKey,
		MessageKey:    "msg",
		StacktraceKey: "stacktrace",
		LineEnding:    zapcore.DefaultLineEnding,
		EncodeLevel:   zapcore.LowercaseLevelEncoder,
		EncodeTime:    zapcore.ISO8601TimeEncoder,
		EncodeDuration: zapcore.StringDurationEncoder,
		EncodeCaller: zapcore.ShortCallerEncoder,
	}

	// 创建核心
	core := zapcore.NewCore(
		zapcore.NewJSONEncoder(encoderCfg),
		zapcore.NewMultiWriteSyncer(zapcore.AddSync(os.Stdout)), // 输出到控制台
		zapcore.InfoLevel, // 日志级别
	)

	// 创建日志记录器
	logger := zap.New(core, zap.AddCaller())
	defer logger.Sync() // 刷新缓冲区

	// 结构化日志
	logger.Info("用户操作",
		zap.String("action", "login"),
		zap.Int("user_id", 12345),
		zap.String("ip", "192.168.1.1"),
	)

	// 不同级别的日志
	logger.Debug("调试信息") // 不会输出，因为设置了InfoLevel
	logger.Info("普通信息")
	logger.Warn("警告信息")
	logger.Error("错误信息")
	// logger.Fatal("致命错误") // 会退出程序
	// logger.Panic("恐慌错误") // 会抛出panic

	// 性能优化的日志方法
	logger.Sugar().Infow("带结构化字段的日志",
		"url", "https://example.com",
		"attempt", 3,
		"backoff", 1.5,
	)
}

4. 日志库选择建议

1. 标准库log：适合简单应用，无结构化日志需求
2. logrus：适合大多数应用，API友好，功能丰富
3. zap：适合高性能应用，对性能要求苛刻的场景

5. 日志最佳实践

1. 根据环境设置不同日志级别(开发环境用Debug，生产环境用Info或更高)
2. 使用结构化日志便于后续分析处理
3. 敏感信息不要记录在日志中
4. 合理控制日志量，避免日志爆炸
5. 考虑日志轮转，避免单个日志文件过大

希望这些示例能帮助你更好地在Go项目中实现结构化日志记录！