0

0

怎样用Golang记录访问日志 结构化日志中间件实现

P粉602998670

P粉602998670

发布时间:2025-08-14 13:01:02

|

439人浏览过

|

来源于php中文网

原创

答案:通过zap实现Go语言结构化日志中间件,记录请求方法、路径、IP、状态码、耗时等信息并以JSON格式输出,结合responseWriter包装捕获状态码,根据级别输出日志,支持客户端IP解析及可选优化如排除健康检查路径、链路追踪等,提升服务可观测性。

怎样用golang记录访问日志 结构化日志中间件实现

在Go语言开发中,记录访问日志是服务可观测性的基础。使用结构化日志(如JSON格式)能更好地对接日志收集系统(如ELK、Loki等),便于搜索和分析。通过编写一个结构化日志中间件,可以自动记录每次HTTP请求的关键信息。

结构化日志中间件设计目标

一个实用的访问日志中间件应记录以下信息:

  • 请求方法(GET、POST等)
  • 请求路径和查询参数
  • 客户端IP地址
  • 响应状态码
  • 处理耗时
  • User-Agent等关键请求头

日志输出为JSON格式,便于后续处理。

使用 zap 实现结构化日志中间件

uber-go/zap 是高性能的结构化日志库,适合生产环境。以下是基于 zap 的中间件实现:

立即学习go语言免费学习笔记(深入)”;

先见AI
先见AI

数据为基,先见未见

下载
package main

import (
    "net"
    "net/http"
    "net/http/httputil"
    "strings"
    "time"

    "github.com/ulule/limiter/v3"
    "go.uber.org/zap"
)

// Logger 中间件,记录结构化访问日志
func Logger(logger *zap.Logger) func(http.Handler) http.Handler {
    return func(next http.Handler) http.Handler {
        return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
            // 记录开始时间
            start := time.Now()

            // 获取客户端IP
            ip := getRealIP(r)

            // 包装 ResponseWriter 以捕获状态码
            rw := &responseWriter{ResponseWriter: w, statusCode: http.StatusOK}

            // 调用下一个处理器
            next.ServeHTTP(rw, r)

            // 构建日志字段
            fields := []zap.Field{
                zap.String("method", r.Method),
                zap.String("path", r.URL.Path),
                zap.String("query", r.URL.RawQuery),
                zap.String("ip", ip),
                zap.String("user_agent", r.Header.Get("User-Agent")),
                zap.Int("status", rw.statusCode),
                zap.Duration("duration", time.Since(start)),
            }

            // 根据状态码选择日志级别
            if rw.statusCode >= 500 {
                logger.Error("server error", fields...)
            } else if rw.statusCode >= 400 {
                logger.Warn("client error", fields...)
            } else {
                logger.Info("access", fields...)
            }
        })
    }
}

// 获取真实客户端IP
func getRealIP(r *http.Request) string {
    xff := r.Header.Get("X-Forwarded-For")
    if xff != "" {
        i := strings.Index(xff, ",")
        if i > 0 {
            return strings.TrimSpace(xff[:i])
        }
        return xff
    }

    xrip := r.Header.Get("X-Real-IP")
    if xrip != "" {
        return xrip
    }

    ip, _, _ := net.SplitHostPort(r.RemoteAddr)
    return ip
}

// 包装 ResponseWriter 以捕获状态码
type responseWriter struct {
    http.ResponseWriter
    statusCode int
}

func (rw *responseWriter) WriteHeader(code int) {
    rw.statusCode = code
    rw.ResponseWriter.WriteHeader(code)
}

在项目中使用中间件

将日志中间件集成到HTTP服务中:

func main() {
    // 创建 zap 日志实例
    logger, _ := zap.NewProduction()
    defer logger.Sync()

    mux := http.NewServeMux()
    mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Write([]byte("Hello, World!"))
    })

    // 应用日志中间件
    handler := Logger(logger)(mux)

    http.ListenAndServe(":8080", handler)
}

运行后,访问服务会输出类似以下的JSON日志:

{
  "level":"info",
  "ts":1712345678.123,
  "caller":"main.go:50",
  "msg":"access",
  "method":"GET",
  "path":"/",
  "query":"",
  "ip":"127.0.0.1",
  "user_agent":"curl/7.68.0",
  "status":200,
  "duration":0.000123
}

可选优化

可根据实际需求扩展功能:

  • 排除健康检查路径(如 /health)减少日志噪音
  • 记录请求体或响应体(注意性能和隐私)
  • 结合 context 记录 trace ID 实现链路追踪
  • 按日志级别输出到不同文件

基本上就这些。一个简洁高效的结构化日志中间件能显著提升服务的可观测性,zap 提供了性能和功能的平衡,适合大多数Go项目使用。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

178

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

226

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

337

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

208

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

389

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

195

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

191

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

192

2025.06.17

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

0

2026.01.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
golang socket 编程
golang socket 编程

共2课时 | 0.1万人学习

nginx浅谈
nginx浅谈

共15课时 | 0.8万人学习

golang和swoole核心底层分析
golang和swoole核心底层分析

共3课时 | 0.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号