在Golang开发的Web应用中,日志记录是排查线上问题、追踪用户请求链路、监控服务运行状态的核心功能。如果日志输出分散在不同模块、格式不统一,会给后续的问题排查带来很大阻碍,因此需要实现统一的日志记录与输出方案。

基础日志需求分析
Web应用的日志通常需要满足以下几个核心要求:
- 统一的日志格式,包含时间、日志级别、请求信息、错误详情等字段
- 支持不同日志级别,比如DEBUG、INFO、WARN、ERROR,方便按需过滤
- 日志可以输出到控制台和文件,同时支持日志文件自动轮转,避免单个文件过大
- 能够和Web框架集成,自动记录每个请求的访问日志和耗时
使用标准库实现基础日志功能
Golang标准库的log包可以满足基础的日志输出需求,我们可以先基于它实现一个简单的统一日志输出工具。
封装统一日志结构
首先定义一个日志结构体,包含日志级别、输出位置等配置:
package logger
import (
"log"
"os"
"time"
)
// 日志级别常量
const (
DEBUG = "DEBUG"
INFO = "INFO"
WARN = "WARN"
ERROR = "ERROR"
)
// Logger 日志结构体
type Logger struct {
level string // 日志级别
logger *log.Logger // 标准库日志实例
}
// NewLogger 初始化日志实例
// level: 日志级别,低于该级别的日志不会输出
// outputPath: 日志输出路径,为空则输出到控制台
func NewLogger(level string, outputPath string) *Logger {
var output *os.File
if outputPath == "" {
output = os.Stdout
} else {
// 创建或打开日志文件
f, err := os.OpenFile(outputPath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
if err != nil {
log.Fatalf("打开日志文件失败: %v", err)
}
output = f
}
// 初始化标准库日志实例,设置前缀和标志位
l := log.New(output, "", 0)
return &Logger{
level: level,
logger: l,
}
}
// 级别优先级映射,数值越大优先级越高
var levelPriority = map[string]int{
DEBUG: 0,
INFO: 1,
WARN: 2,
ERROR: 3,
}
// log 内部统一日志输出方法
func (l *Logger) log(level string, format string, args ...interface{}) {
// 判断当前日志级别是否需要输出
if levelPriority[level] < levelPriority[l.level] {
return
}
// 格式化日志内容,包含时间和级别
msg := time.Now().Format("2006-01-02 15:04:05") + " [" + level + "] "
if format != "" {
msg += fmt.Sprintf(format, args...)
} else {
msg += fmt.Sprint(args...)
}
l.logger.Println(msg)
}
// Debug 输出DEBUG级别日志
func (l *Logger) Debug(format string, args ...interface{}) {
l.log(DEBUG, format, args...)
}
// Info 输出INFO级别日志
func (l *Logger) Info(format string, args ...interface{}) {
l.log(INFO, format, args...)
}
// Warn 输出WARN级别日志
func (l *Logger) Warn(format string, args ...interface{}) {
l.log(WARN, format, args...)
}
// Error 输出ERROR级别日志
func (l *Logger) Error(format string, args ...interface{}) {
l.log(ERROR, format, args...)
}
基础使用示例
在Web应用入口处初始化日志实例,然后在业务代码中调用:
package main
import (
"fmt"
"net/http"
"your_project/logger"
)
var log *logger.Logger
func main() {
// 初始化日志,级别为INFO,输出到当前目录的app.log文件
log = logger.NewLogger(logger.INFO, "app.log")
defer func() {
// 关闭日志文件
if f, ok := log.Logger.Writer().(*os.File); ok {
f.Close()
}
}()
http.HandleFunc("/test", testHandler)
log.Info("服务启动,监听端口: 8080")
http.ListenAndServe(":8080", nil)
}
func testHandler(w http.ResponseWriter, r *http.Request) {
log.Info("收到请求: %s %s", r.Method, r.URL.Path)
// 业务逻辑
fmt.Fprintf(w, "请求处理成功")
log.Info("请求处理完成: %s", r.URL.Path)
}
集成日志轮转功能
标准库没有内置日志轮转功能,日志文件会不断增大,我们可以使用gopkg.in/natefinch/lumberjack.v2第三方库实现日志自动切割。
安装依赖
执行以下命令安装日志轮转库:
go get gopkg.in/natefinch/lumberjack.v2
修改日志初始化逻辑
调整NewLogger方法,使用lumberjack作为日志输出:
package logger
import (
"log"
"time"
"gopkg.in/natefinch/lumberjack.v2"
)
// NewLoggerWithRotate 带轮转功能的日志初始化
// level: 日志级别
// outputPath: 日志文件路径
// maxSize: 单个日志文件最大大小,单位MB
// maxBackups: 最多保留的旧日志文件数量
// maxAge: 日志文件保留天数
func NewLoggerWithRotate(level string, outputPath string, maxSize int, maxBackups int, maxAge int) *Logger {
// 配置日志轮转
lumberjackLogger := &lumberjack.Logger{
Filename: outputPath,
MaxSize: maxSize, // 单个文件最大10MB
MaxBackups: maxBackups, // 最多保留5个备份
MaxAge: maxAge, // 日志保留30天
Compress: true, // 压缩旧日志
}
l := log.New(lumberjackLogger, "", 0)
return &Logger{
level: level,
logger: l,
}
}
初始化时调用新方法即可实现日志自动轮转:
// 初始化带轮转的日志,级别INFO,输出到app.log,单个文件最大10MB,最多5个备份,保留30天 log = logger.NewLoggerWithRotate(logger.INFO, "app.log", 10, 5, 30)
Web框架中间件集成
如果是使用Gin、Echo等Web框架,可以通过中间件自动记录每个请求的访问日志,不需要在每个接口中手动写日志。
Gin框架中间件示例
以下是一个Gin框架的请求日志中间件实现:
package middleware
import (
"time"
"your_project/logger"
"github.com/gin-gonic/gin"
)
// RequestLogger 请求日志中间件
func RequestLogger(log *logger.Logger) gin.HandlerFunc {
return func(c *gin.Context) {
startTime := time.Now()
// 处理请求
c.Next()
endTime := time.Now()
latency := endTime.Sub(startTime)
// 获取请求信息
method := c.Request.Method
path := c.Request.URL.Path
statusCode := c.Writer.Status()
clientIP := c.ClientIP()
// 输出请求日志
log.Info("请求日志 | 方法: %s | 路径: %s | 状态码: %d | 耗时: %v | 客户端IP: %s",
method, path, statusCode, latency, clientIP)
}
}
在Gin中注册中间件:
package main
import (
"your_project/logger"
"your_project/middleware"
"github.com/gin-gonic/gin"
)
var log *logger.Logger
func main() {
log = logger.NewLoggerWithRotate(logger.INFO, "app.log", 10, 5, 30)
r := gin.New()
// 注册请求日志中间件
r.Use(middleware.RequestLogger(log))
// 注册业务路由
r.GET("/test", func(c *gin.Context) {
c.JSON(200, gin.H{"msg": "success"})
})
r.Run(":8080")
}
统一日志格式建议
为了方便日志采集和分析,建议统一日志的JSON格式,包含以下核心字段:
| 字段名 | 说明 | 示例值 |
|---|---|---|
| timestamp | 日志产生时间 | 2024-05-20 14:30:00 |
| level | 日志级别 | INFO |
| service | 服务名称 | user-service |
| trace_id | 请求链路ID | abc123def456 |
| message | 日志内容 | 用户登录成功 |
| request_id | 请求唯一ID | req_789012 |
可以在之前的Logger结构体中调整log方法的输出格式,将日志内容序列化为JSON后输出,方便后续接入ELK等日志分析系统。
注意事项
- 生产环境不要开启DEBUG级别日志,避免输出过多无用信息影响性能
- 日志中不要包含用户敏感信息,比如密码、身份证号、手机号等
- 日志输出是IO操作,高并发场景下可以考虑异步输出,避免阻塞请求处理
- 定期检查日志文件的存储情况,避免磁盘空间被占满