gin框架中使用prometheus统计http方法、路径和耗时

prometheus是一个开源的系统监控和报警工具，作为新一代的云原生监控系统，它可以和grafana等开源组件很好的结合在一起，也为golang提供了对应的集成工具

这边我主要介绍gin框架中如何集成prometheus来实现统计http方法和路径

一、包依赖

在系统中先安装好对应的prometheus包，如下

go get github.com/gin-gonic/gin
go get github.com/prometheus/client_golang/prometheus
go get github.com/prometheus/client_golang/prometheus/promhttp

二、代码实例

package main

import (
    "fmt"
    "github.com/gin-gonic/gin"
    "github.com/prometheus/client_golang/prometheus"
    "github.com/prometheus/client_golang/prometheus/promhttp"
    "net/http"
    "time"
)

var (
    WebRequestTotal = prometheus.NewCounterVec(prometheus.CounterOpts{
        Name: "web_reqeust_total",
        Help: "Number of hello requests in total",
    }, []string{"method", "path"})
    WebRequestDurationHistogram = prometheus.NewHistogramVec(prometheus.HistogramOpts{
        Name:    "http_request_duration_seconds",
        Help:    "Histogram of the duration of HTTP requests",
        Buckets: prometheus.DefBuckets,
    }, []string{"method", "path"})
)

func init() {
    // 注册计数器到 Prometheus
    prometheus.MustRegister(WebRequestTotal)
    // 注册直方图到 Prometheus
    prometheus.MustRegister(WebRequestDurationHistogram)
}
func main() {
    r := gin.Default() //创建gin

    r.Use(func(c *gin.Context) {
        start := time.Now()
        //处理请求
        c.Next()
        duration := time.Since(start).Seconds()
        //记录请求次数
        WebRequestTotal.WithLabelValues(c.Request.Method, c.Request.URL.Path).Inc()
           //记录http方法和路径对应的耗时
        WebRequestDurationHistogram.WithLabelValues(c.Request.Method, c.Request.URL.Path).Observe(duration)
    })
    r.GET("/", index) //绑定路由
    r.GET("/metrics", gin.WrapH(promhttp.Handler()))
    // 定义一个健康检查的路由
    r.GET("/health", func(c *gin.Context) {
        c.String(http.StatusOK, "OK")
    })
    r.POST("/update", func(c *gin.Context) {
        c.String(http.StatusOK, "OK")
    })
    r.Run(":8001") //运行绑定端口
}

func index(c *gin.Context) {
    fmt.Println("1111")
    c.JSON(200, gin.H{
        "message": "go!go!gono!yesyes",
    })
}

说明

1、WebRequestTotal这是一个“CounterVec”类型的计数器，用于统计不同http方法和路径的请求次数
2、WebRequestDurationHistogram这是一个“HistogramVe”类型的直方图，用于记录不同http方法和路径的请求持续时间，使用了“prometheus.DefBucket”提供的默认的桶分布，当然这个也可以自定义
3、采用了中间件
a、使用中间件拦截了请求，当结束后更新对应的计数器
b、在中间件在请求开始和请求结束分别记录了时间，得到请求的耗时，并且记录到了直方图中
4、通过访问http://localhost:8001/metrics来实现对指标的查询

如下显示的是不同http方法和路径的请求次数

image.png

如下则显示的是不同http方法和路径的请求持续时间，安装桶进行分布

image.png