Prometheus

Prometheus 的埋点方式跟 StatsD 很像,对于请求数量和延迟这样的监控指标,也是在请求处理完成之后,调用 SDK 的方法进行记录的。不过,如果每个方法都要加这么几行代码就显得太冗余了,最好还是通过 AOP 的方式做一些切面逻辑,Nightingale 的 Webapi 模块就是这么干的,我直接用这个 代码 给你讲解。

Webapi 的职能是提供一系列 HTTP 接口给 JavaScript 调用,我们需要监控这些接口的调用量、成功率、延迟数据。埋点之前我们先规划一下标签,我们给每个 HTTP 接口规划 4 个标签。

Prometheus 埋点需要提前把指标变量定义出来,我们使用一个单独的包来放置,你可以看一下 相关代码。

package stat

import (
        "time"

        "github.com/prometheus/client_golang/prometheus"
)

const Service = "n9e-webapi"

var (
        labels = []string{"service", "code", "path", "method"}

        uptime = prometheus.NewCounterVec(
                prometheus.CounterOpts{
                        Name: "uptime",
                        Help: "HTTP service uptime.",
                }, []string{"service"},
        )

        RequestCounter = prometheus.NewCounterVec(
                prometheus.CounterOpts{
                        Name: "http_request_count_total",
                        Help: "Total number of HTTP requests made.",
                }, labels,
        )

        RequestDuration = prometheus.NewHistogramVec(
                prometheus.HistogramOpts{
                        Buckets: []float64{.01, .1, 1, 10},
                        Name:    "http_request_duration_seconds",
                        Help:    "HTTP request latencies in seconds.",
                }, labels,
        )
)

func Init() {
        // Register the summary and the histogram with Prometheus's default registry.
        prometheus.MustRegister(
                uptime,
                RequestCounter,
                RequestDuration,
        )

        go recordUptime()
}

// recordUptime increases service uptime per second.
func recordUptime() {
        for range time.Tick(time.Second) {
                uptime.WithLabelValues(Service).Inc()
        }
}

uptime 变量是顺手为之,统计进程启动了多长时间,不用太关注,RequestCounter 和 RequestDuration,分别统计请求流量和请求延迟。Init 方法是在 Webapi 模块进程初始化的时候调用,所以进程一起,就会自动注册好。

然后我们写一个 middleware,在请求进来的时候拦截一下,省得每个请求都要去统计,你可以看一下 middleware 方法的 代码。

func stat() gin.HandlerFunc {
                return func(c *gin.Context) {
                        start := time.Now()
                        c.Next()

                        code := fmt.Sprintf("%d", c.Writer.Status())
                        method := c.Request.Method
                        labels := []string{promstat.Service, code, c.FullPath(), method}

                        promstat.RequestCounter.WithLabelValues(labels...).Inc()
                        promstat.RequestDuration.WithLabelValues(labels...).Observe(float64(time.Since(start).Seconds()))
                }
        }

有了这个 middleware 之后,new 出 gin 的 engine 的时候,就立马 Use 一下。

...
r := gin.New()
r.Use(stat())
...

最后,监控数据要通过/metrics接口暴露出去,我们要暴露这个请求端点。

import (
        ...
        "github.com/prometheus/client_golang/prometheus/promhttp"
)
func configRoute(r *gin.Engine, version string) {
        ...
        r.GET("/metrics", gin.WrapH(promhttp.Handler()))
}

这样,每个 Webapi 接口的流量和成功率都可以监控到了。如果你也部署了 Nightingale,请求 Webapi(默认是18000)的 /metrics 接口看看返回的内容吧。