stdlog - Go语言分级日志记录插件库

stdlog 是一个轻量级的Go语言日志库，提供了分级日志记录功能，支持插件化扩展。下面我将详细介绍如何使用stdlog库。

安装

go get github.com/aybabtme/stdlog

基本用法

1. 简单日志记录

package main

import (
	"github.com/aybabtme/stdlog"
)

func main() {
	log := stdlog.LogTo(stdlog.Out, "example")
	
	log.Info("这是一条信息日志")
	log.Debug("这是一条调试日志")
	log.Warn("这是一条警告日志")
	log.Err("这是一条错误日志")
}

2. 日志级别控制

stdlog支持以下日志级别：

• Debug
• Info
• Warn
• Err

func main() {
	// 设置日志级别为Warn，只记录Warn及以上级别的日志
	log := stdlog.LogTo(stdlog.Out, "example").SetLevel(stdlog.Warn)
	
	log.Debug("这条调试日志不会被记录")
	log.Info("这条信息日志不会被记录")
	log.Warn("这条警告日志会被记录")
	log.Err("这条错误日志会被记录")
}

3. 结构化日志

func main() {
	log := stdlog.LogTo(stdlog.Out, "example")
	
	// 带字段的日志
	log.InfoKV("用户登录", stdlog.KV{
		"user_id": 12345,
		"ip":      "192.168.1.1",
	})
	
	// 更简洁的写法
	log.Info("用户登录", "user_id", 12345, "ip", "192.168.1.1")
}

高级用法

1. 自定义输出

func main() {
	// 输出到文件
	file, err := os.Create("app.log")
	if err != nil {
		panic(err)
	}
	defer file.Close()
	
	log := stdlog.LogTo(file, "file-logger")
	log.Info("这条日志会写入文件")
	
	// 输出到标准错误
	errLog := stdlog.LogTo(os.Stderr, "error-logger")
	errLog.Err("这条错误日志会输出到stderr")
}

2. 自定义格式

func main() {
	log := stdlog.LogTo(stdlog.Out, "custom-format").SetFormat(func(lvl stdlog.Level, msg string, kv stdlog.KV) string {
		return fmt.Sprintf("[%s] %s: %s %v", time.Now().Format(time.RFC3339), lvl, msg, kv)
	})
	
	log.Info("自定义格式日志", "key", "value")
}

3. 插件扩展

stdlog支持通过插件扩展功能，例如添加日志发送到远程服务器：

type RemoteLogPlugin struct {
	client *http.Client
	url    string
}

func (p *RemoteLogPlugin) Log(lvl stdlog.Level, msg string, kv stdlog.KV) {
	// 实现远程日志发送逻辑
	// ...
}

func main() {
	log := stdlog.LogTo(stdlog.Out, "with-plugin")
	
	// 添加插件
	plugin := &RemoteLogPlugin{
		client: http.DefaultClient,
		url:    "https://example.com/log",
	}
	log.AddPlugin(plugin)
	
	log.Info("这条日志会被本地记录并发送到远程服务器")
}

性能优化

对于高性能场景，可以使用缓冲写入：

func main() {
	// 使用缓冲写入器
	bufWriter := bufio.NewWriter(os.Stdout)
	defer bufWriter.Flush()
	
	log := stdlog.LogTo(bufWriter, "buffered")
	
	for i := 0; i < 10000; i++ {
		log.Info("高性能日志记录", "iteration", i)
	}
}

最佳实践

1. 合理使用日志级别：

   • Debug: 调试信息
   • Info: 重要业务信息
   • Warn: 需要注意但不影响程序运行的情况
   • Err: 错误情况

2. 避免过度日志记录：只记录必要的信息，避免日志文件过大

3. 结构化日志：尽量使用键值对形式记录日志，便于后续分析

4. 区分日志输出：可以将不同级别的日志输出到不同的目标

5. 生产环境配置：

   func NewProductionLogger() stdlog.Logger {
       return stdlog.LogTo(stdlog.Out, "app").
           SetLevel(stdlog.Info).  // 生产环境通常不记录Debug日志
           SetFormat(stdlog.JSONFormat)  // 使用JSON格式便于日志收集系统处理
   }
   

stdlog是一个简单但功能完善的日志库，适合大多数Go应用程序的日志需求。它的插件系统使得可以轻松扩展功能，满足各种定制化需求。