通过中间件为每个HTTP请求生成唯一trace ID并结合结构化日志实现请求追踪,提升Go服务的可观测性。1. 使用context传递trace ID;2. 中间件记录请求开始与结束;3. 处理函数中获取trace ID用于日志;4. 采用slog输出JSON格式日志,便于聚合分析。完整示例包含自定义中间件、trace ID生成、slog集成及路由处理,确保全流程可追踪。

在构建 Golang HTTP 服务器时,良好的日志记录和请求追踪机制能显著提升系统的可观测性和调试效率。通过为每个请求生成唯一 ID 并贯穿整个处理流程,可以更方便地排查问题、分析性能瓶颈。下面是一个简单但实用的日志记录与请求追踪示例。
使用中间件实现请求追踪
请求追踪的核心是为每个进入的 HTTP 请求分配一个唯一标识(trace ID),并将其注入到上下文中,供后续处理函数使用。通常通过中间件来实现这一逻辑。
以下是一个自定义中间件的实现:
func RequestLogger(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// 生成唯一 trace ID
traceID := generateTraceID()
// 将 trace ID 加入 context
ctx := context.WithValue(r.Context(), "traceID", traceID)
// 记录请求开始
log.Printf("[START] %s %s - traceID: %s", r.Method, r.URL.Path, traceID)
// 构造带 context 的新请求
r = r.WithContext(ctx)
// 执行下一个处理器
next.ServeHTTP(w, r)
// 记录请求结束
log.Printf("[END] %s %s - traceID: %s", r.Method, r.URL.Path, traceID)
})}
立即学习“go语言免费学习笔记(深入)”;
func generateTraceID() string {
return fmt.Sprintf("%d", time.Now().UnixNano())
}
在处理函数中使用 trace ID
一旦 trace ID 被注入到 context 中,你可以在任何支持 context 的处理逻辑中提取并使用它,确保日志的一致性和可追踪性。
func helloHandler(w http.ResponseWriter, r *http.Request) {
traceID, _ := r.Context().Value("traceID").(string)
log.Printf("Handling request - traceID: %s", traceID)
// 模拟业务逻辑
time.Sleep(100 * time.Millisecond)
w.WriteHeader(http.StatusOK)
fmt.Fprintf(w, "Hello! Your trace ID is: %s", traceID)}
立即学习“go语言免费学习笔记(深入)”;
结合结构化日志提升可读性
标准 log 包输出的是纯文本,不利于后期分析。推荐使用结构化日志库如 logrus 或 slog(Go 1.21+)来输出 JSON 格式日志,便于集成 ELK 或其他日志系统。
以下是使用 Go 内置 slog 的示例:
var logger = slog.New(slog.NewJSONHandler(os.Stdout, nil))func RequestLoggerWithSlog(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { traceID := generateTraceID()
// 使用 slog 记录进入请求 logger.Info("request started", "method", r.Method, "path", r.URL.Path, "trace_id", traceID, "remote_addr", r.RemoteAddr, ) ctx := context.WithValue(r.Context(), "traceID", traceID) r = r.WithContext(ctx) next.ServeHTTP(w, r) logger.Info("request completed", "method", r.Method, "path", r.URL.Path, "trace_id", traceID, ) })}
立即学习“go语言免费学习笔记(深入)”;
这样每条日志都包含关键字段,可通过 trace_id 快速聚合一次请求的所有日志条目。
完整示例运行
将上述组件组合起来:
func main() {
mux := http.NewServeMux()
mux.HandleFunc("/hello", helloHandler)
loggedMux := RequestLoggerWithSlog(mux)
log.Println("Server starting on :8080")
http.ListenAndServe(":8080", loggedMux)}
立即学习“go语言免费学习笔记(深入)”;
访问 http://localhost:8080/hello 后,你会看到类似如下的结构化日志输出:
{"level":"INFO","time":"2024-04-05T10:00:00Z","msg":"request started","method":"GET","path":"/hello","trace_id":"1234567890","remote_addr":"127.0.0.1:54321"}
{"level":"INFO","time":"2024-04-05T10:00:00Z","msg":"Handling request","trace_id":"1234567890"}
{"level":"INFO","time":"2024-04-05T10:00:00Z","msg":"request completed","method":"GET","path":"/hello","trace_id":"1234567890"}
基本上就这些。通过中间件 + context + 结构化日志,你可以轻松实现清晰的请求追踪能力。不复杂但容易忽略细节,比如 trace ID 的传递一致性。建议统一封装 context key 类型避免冲突,进一步提升代码健壮性。










