使用Prometheus搞定微服务监控
最近对服务进行监控,而当前监控最流行的数据库就是 Prometheus
,同时 go-zero
默认接入也是这款数据库。今天就对 go-zero
是如何接入 Prometheus
,以及开发者如何自己定义自己监控指标。
监控接入
go-zero
框架中集成了基于 prometheus
的服务指标监控。但是没有显式打开,需要开发者在 config.yaml
中配置:
Prometheus:
Host: 127.0.0.1
Port: 9091
Path: /metrics
如果开发者是在本地搭建 Prometheus
,需要在 Prometheus
的配置文件 prometheus.yaml
中写入需要收集服务监控信息的配置:
- job_name: 'file_ds'
static_configs:
- targets: ['your-local-ip:9091']
labels:
job: activeuser
app: activeuser-api
env: dev
instance: your-local-ip:service-port
因为本地是用 docker
运行的。将 prometheus.yaml
放置在 docker-prometheus
目录下:
docker run \
-p 9090:9090 \
-v dockeryml/docker-prometheus:/etc/prometheus \
prom/prometheus
打开 localhost:9090
就可以看到:
点击 http://service-ip:9091/metrics
就可以看到该服务的监控信息:
上图我们可以看出有两种 bucket
,以及 count/sum
指标。
那 go-zero
是如何集成监控指标?监控的又是什么指标?我们如何定义我们自己的指标?下面就来解释这些问题
以上的基本接入,可以参看我们的另外一篇:https://zeromicro.github.io/go-zero/service-monitor.html
如何集成
上面例子中的请求方式是 HTTP
,也就是在请求服务端时,监控指标数据不断被搜集。很容易想到是 中间件 的功能,具体代码:https://github.com/tal-tech/go-zero/blob/master/rest/handler/prometheushandler.go。
var (
metricServerReqDur = metric.NewHistogramVec(&metric.HistogramVecOpts{
...
// 监控指标
Labels: []string{"path"},
// 直方图分布中,统计的桶
Buckets: []float64{5, 10, 25, 50, 100, 250, 500, 1000},
})
metricServerReqCodeTotal = metric.NewCounterVec(&metric.CounterVecOpts{
...
// 监控指标:直接在记录指标 incr() 即可
Labels: []string{"path", "code"},
})
)
func PromethousHandler(path string) func(http.Handler) http.Handler {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// 请求进入的时间
startTime := timex.Now()
cw := &security.WithCodeResponseWriter{Writer: w}
defer func() {
// 请求返回的时间
metricServerReqDur.Observe(int64(timex.Since(startTime)/time.Millisecond), path)
metricServerReqCodeTotal.Inc(path, strconv.Itoa(cw.Code))
}()
// 中间件放行,执行完后续中间件和业务逻辑。重新回到这,做一个完整请求的指标上报
// [