Gin Prometheus 指标导出器使用教程

1. 项目的目录结构及介绍

ginprom/
├── README.md
├── example
│   └── main.go
├── ginprom.go
├── go.mod
├── go.sum
└── prom.go

• README.md: 项目说明文档，包含项目的基本信息和使用方法。
• example/main.go: 示例代码，展示如何在 Gin 框架中使用 ginprom。
• ginprom.go: 核心文件，包含 Gin 中间件的实现，用于收集和导出 Prometheus 指标。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• prom.go: 辅助文件，包含与 Prometheus 相关的配置和初始化代码。

2. 项目的启动文件介绍

example/main.go

package main

import (
    "github.com/chenjiandongx/ginprom"
    "github.com/gin-gonic/gin"
)

func main() {
    r := gin.Default()
    p := ginprom.New(
        ginprom.Engine(r),
        ginprom.Subsystem("gin"),
        ginprom.Path("/metrics"),
    )
    r.Use(p.Instrument())

    r.GET("/", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "Hello, world!",
        })
    })

    r.Run()
}

• gin.Default(): 创建一个默认的 Gin 引擎。
• ginprom.New(): 创建一个 ginprom 实例，并配置相关参数。
• r.Use(p.Instrument()): 将 ginprom 中间件注册到 Gin 引擎中。
• r.GET("/", ...): 定义一个简单的路由处理函数。
• r.Run(): 启动 Gin 服务器。

3. 项目的配置文件介绍

ginprom 项目本身没有独立的配置文件，其配置主要通过代码中的参数进行设置。以下是一些常用的配置选项：

ginprom.New() 参数

• Engine(r *gin.Engine): 指定要使用的 Gin 引擎。
• Subsystem(subsystem string): 设置 Prometheus 指标的子系统名称。
• Path(path string): 设置 Prometheus 指标的暴露路径，默认为 /metrics。
• Namespace(namespace string): 设置 Prometheus 指标的命名空间。
• Ignore(paths ...string): 指定要忽略的路径，这些路径不会被收集指标。

通过这些参数，可以灵活地配置 ginprom 的行为，以满足不同的监控需求。

---

以上是基于开源项目 chenjiandongx/ginprom 的详细使用教程，希望对你有所帮助。