Gin Contrib Logger 使用教程

Gin Contrib Logger 使用教程

logger Gin middleware/handler to logger url path using rs/zerolog 项目地址: https://gitcode.com/gh_mirrors/logger2/logger

1. 项目介绍

Gin Contrib Logger 是一个为 Gin Web 框架提供的日志中间件，它使用 rs/zerolog 作为日志记录工具。该中间件能够记录所有请求的详细信息，包括请求路径、请求方法、响应状态码等，帮助开发者更好地监控和调试应用程序。

2. 项目快速启动

首先，确保你已经安装了 Go 语言环境。接下来，按照以下步骤快速启动一个带有 Gin Contrib Logger 的 Gin Web 应用。

package main

import (
	"github.com/gin-contrib/logger"
	"github.com/gin-gonic/gin"
	"gopkg.in/ini.v1"
)

func main() {
	// 创建一个 Gin 实例
	r := gin.New()

	// 添加 Logger 中间件
	r.Use(logger.SetLogger())

	// 设置一个简单的路由
	r.GET("/ping", func(c *gin.Context) {
		c.String(200, "pong")
	})

	// 运行服务器
	r.Run(":8080")
}

在上面的代码中，我们创建了一个新的 Gin 实例，并使用 logger.SetLogger() 添加了日志中间件。然后，我们定义了一个简单的 GET 路由 /ping，当请求这个路由时，会返回响应 "pong"。

3. 应用案例和最佳实践

日志格式自定义

你可以通过自定义配置来改变日志的格式，例如：

import (
	"github.com/rs/zerolog"
	"github.com/gin-contrib/logger"
)

// ...

r.Use(logger.SetLogger(logger.Config{
	// 定义日志输出的格式
	Formatter: func(param logger.LogFormatterParams) string {
		return fmt.Sprintf("[GIN] %v | %3d | %13v | %s | %s\n",
			param.TimeStamp.Format("2006/01/02 - 15:04:05"),
			param.StatusCode,
			param.Latency,
			param.ClientIP,
			param.Method,
			param.Path,
		)
	},
}))

路由过滤

如果你不想记录某些特定路由的日志，可以使用 WithSkipPath 方法：

// ...
r.Use(logger.SetLogger(logger.Config{
	// 跳过记录的路由
	SkipPaths: []string{"/health"},
}))

4. 典型生态项目

• Gin Web Framework: Gin 是一个高性能的 Web 框架，Gin Contrib Logger 是其生态中的一个日志中间件。
• Rs/Zerolog: Rs/Zerolog 是一个强大的日志库，提供了结构化的日志记录和方便的日志管理功能。

以上是 Gin Contrib Logger 的基础使用教程，你可以根据自己的项目需求进一步定制和优化日志记录策略。

logger Gin middleware/handler to logger url path using rs/zerolog 项目地址: https://gitcode.com/gh_mirrors/logger2/logger