gin-metrics 项目使用教程

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

gin-metrics 项目的目录结构如下：

gin-metrics/
├── README.md
├── README_zh.md
├── go.mod
├── go.sum
├── ginmetrics/
│   ├── metrics.go
│   ├── middleware.go
│   ├── options.go
│   └── utils.go
└── example/
    ├── main.go
    └── config.yaml

目录介绍

• README.md 和 README_zh.md：项目的说明文档，分别用英文和中文编写。
• go.mod 和 go.sum：Go 模块文件，用于管理项目的依赖。
• ginmetrics/：核心代码目录，包含 metrics 的定义、中间件、选项和工具函数。
  • metrics.go：定义了各种监控指标。
  • middleware.go：实现了 Gin 中间件，用于收集指标数据。
  • options.go：提供了配置选项。
  • utils.go：包含一些工具函数。
• example/：示例代码目录，包含一个简单的示例项目。
  • main.go：示例项目的启动文件。
  • config.yaml：示例项目的配置文件。

2. 项目的启动文件介绍

在 example/ 目录下，main.go 是示例项目的启动文件。以下是 main.go 的主要内容：

package main

import (
    "github.com/gin-gonic/gin"
    "github.com/penglongli/gin-metrics/ginmetrics"
)

func main() {
    r := gin.Default()

    // get global Monitor object
    m := ginmetrics.GetMonitor()

    // +optional set metric path, default /debug/metrics
    m.SetMetricPath("/metrics")

    // +optional set slow time, default 5s
    m.SetSlowTime(10)

    // +optional set request duration, default {0.1, 0.3, 1.2, 5, 10}
    // used to p95, p99
    m.SetDuration([]float64{0.1, 0.3, 1.2, 5, 10})

    // set middleware for gin
    m.Use(r)

    r.GET("/", func(c *gin.Context) {
        c.String(200, "Hello, gin-metrics!")
    })

    r.Run(":8080")
}

启动文件介绍

• 引入必要的包：gin 和 ginmetrics。
• 创建一个 Gin 路由器实例 r。
• 获取全局监控对象 m。
• 配置监控路径、慢请求时间和请求持续时间。
• 将监控中间件应用到 Gin 路由器。
• 定义一个简单的路由处理函数。
• 启动 Gin 服务器，监听端口 8080。

3. 项目的配置文件介绍

在 example/ 目录下，config.yaml 是示例项目的配置文件。以下是 config.yaml 的内容：

metric:
  path: /metrics
  slowTime: 10
  duration: [0.1, 0.3, 1.2, 5, 10]

配置文件介绍

• path：监控指标的暴露路径，默认为 /metrics。
• slowTime：慢请求的阈值，单位为秒，默认为 5 秒。
• duration：请求持续时间的分位数配置，用于计算 p95 和 p99，默认为 [0.1, 0.3, 1.2, 5, 10]。

通过这些配置，可以灵活地调整监控指标的收集和暴露方式。