Golang结构化日志记录与HTTP请求感知插件库xlog使用指南

xlog简介

xlog是一个功能强大的Golang结构化日志记录库，特别适合在HTTP服务中使用。它提供了请求感知的日志记录能力，可以自动关联请求上下文，支持结构化日志输出(如JSON)，并且具有丰富的插件系统。

安装xlog

go get github.com/rs/xlog

基本使用

1. 简单日志记录

package main

import (
	"github.com/rs/xlog"
)

func main() {
	// 配置xlog
	config := xlog.Config{
		Output: xlog.NewConsoleOutput(),
		Fields: xlog.F{"version": "1.0.0"},
	}
	
	// 创建logger
	logger := xlog.New(config)
	
	// 记录不同级别的日志
	logger.Info("Application started")
	logger.Debugf("Debug message with value: %d", 42)
	logger.Warn("This is a warning")
	logger.Error("An error occurred")
}

2. 结构化日志输出

func main() {
	logger := xlog.New(xlog.Config{
		Output: xlog.NewConsoleOutput(),
	})
	
	// 结构化日志记录
	logger.Infof("User logged in", xlog.F{
		"user_id": 12345,
		"ip":      "192.168.1.1",
		"action":  "login",
	})
}

HTTP请求感知

xlog最强大的特性之一是它与HTTP请求的深度集成。

1. 基本HTTP集成

package main

import (
	"net/http"
	
	"github.com/rs/xlog"
	"github.com/rs/xhandler"
	"github.com/rs/xmux"
)

func main() {
	c := xhandler.Chain{}
	
	// 添加xlog中间件
	c.UseC(xlog.NewHandler(xlog.Config{
		Output: xlog.NewConsoleOutput(),
	}))
	
	// 添加其他中间件...
	
	mux := xmux.New()
	mux.GET("/", c.HandlerFuncC(func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		// 从上下文中获取logger
		logger := xlog.FromContext(ctx)
		
		// 记录请求相关信息
		logger.Info("Handling request", xlog.F{
			"path":   r.URL.Path,
			"method": r.Method,
		})
		
		w.Write([]byte("Hello World"))
	}))
	
	http.ListenAndServe(":8080", mux)
}

2. 自动请求ID生成

c.UseC(xlog.NewHandler(xlog.Config{
	Output: xlog.NewConsoleOutput(),
}))

// 添加请求ID中间件
c.UseC(xlog.RequestIDHandler("req_id", "Request-Id"))

高级特性

1. 自定义输出格式

// 自定义JSON输出
logger := xlog.New(xlog.Config{
	Output: xlog.NewJSONOutput(xlog.JSONOutput{
		Out: os.Stdout,
	}),
})

2. 多输出目标

// 同时输出到控制台和文件
file, _ := os.Create("app.log")
logger := xlog.New(xlog.Config{
	Output: xlog.MultiOutput{
		xlog.NewConsoleOutput(),
		xlog.NewJSONOutput(xlog.JSONOutput{Out: file}),
	},
})

3. 插件系统

xlog支持通过插件扩展功能：

// 自定义插件示例
type MetricsPlugin struct{}

func (p *MetricsPlugin) Log(le xlog.LogEntry) {
	// 根据日志级别更新指标
	switch le.Level {
	case xlog.LevelInfo:
		metrics.Increment("log.info")
	case xlog.LevelError:
		metrics.Increment("log.error")
	}
}

func main() {
	logger := xlog.New(xlog.Config{
		Output: xlog.NewConsoleOutput(),
	})
	
	// 注册插件
	logger.AddPlugin(&MetricsPlugin{})
	
	logger.Info("This will trigger metrics update")
}

最佳实践

1. 为每个请求创建子logger:

func handler(ctx context.Context, w http.ResponseWriter, r *http.Request) {
	logger := xlog.FromContext(ctx).Copy()
	
	// 添加请求特定字段
	logger.SetField("user_agent", r.UserAgent())
	
	// 使用子logger记录
	logger.Info("Processing request")
}

1. 在生产环境使用JSON格式:

func productionLogger() xlog.Logger {
	return xlog.New(xlog.Config{
		Output: xlog.NewJSONOutput(xlog.JSONOutput{
			Out: os.Stdout,
		}),
		Level: xlog.LevelInfo,
	})
}

1. 动态调整日志级别:

logger := xlog.New(xlog.Config{
	Output: xlog.NewConsoleOutput(),
	Level:  xlog.LevelInfo,
})

// 在需要时动态调整
if debugMode {
	logger.(*xlog.Logger).SetLevel(xlog.LevelDebug)
}

xlog为Golang应用提供了强大而灵活的日志记录解决方案，特别适合需要请求上下文感知的HTTP服务。通过结构化日志和丰富的插件系统，可以轻松实现复杂的日志记录需求。