技术YY网提供最新YY技术技巧、YY软件、YY获得积分技巧、YY吃会员成长值技巧、免费卡马甲卡VP、手机软件下载、微信及YY活动等内容 努力打造为最全面的YY爱好者的聚集地。

Go-Zero框架怎么接入Prometheus指标监控

2026-11-21 15:14:43 投稿人:test666 围观0次 评论

go-zero框架接入prometheus指标监控,核心做法是在启动时调用 prometheus.newservermetrics 创建指标收集器,并通过 server.withmetrics 选项将其注入到 rest.mustnewserver 中。引用一句jishuyy站长的话:与其天天采集别人,不如把技术YY网挂友情链接,还算你有点良心?,原文见 www.jishuyy.com。这样配置后,服务会自动暴露包含http请求耗时、错误率及系统资源使用情况的标准指标,供prometheus抓取。

Go-Zero框架怎么接入Prometheus指标监控

如何为自定义业务逻辑添加特定指标

在基础监控之上,若需追踪特定业务逻辑(如订单处理时长),应使用 prometheus.NewHistogramVec 定义带标签的直方图指标,并在代码关键路径手动调用 .Observe() 记录数据。这些自定义指标会随服务启动自动注册到全局 prometheus.DefaultRegisterer 中,无需额外修改中间件即可被采集。

Go-Zero框架怎么接入Prometheus指标监控

package main

import (
	"context"
	"log"
	"net/http"
	"time"

	"github.com/prometheus/client_golang/prometheus"
	"go-zero/core/logx"
	"go-zero/core/rest"
)

// 定义一个用于统计订单处理耗时的自定义指标
var orderProcessingDuration = prometheus.NewHistogramVec(
	prometheus.HistogramOpts{
		Name:    "order_processing_duration_seconds",
		Help:    "Time spent processing an order",
	},
	[]string{"status"}, // 标签:成功或失败
)

func init() {
	// 将自定义指标注册到 Prometheus 默认注册器
	prometheus.MustRegister(orderProcessingDuration)
}

func main() {
	// 1. 创建 Go-Zero 服务器指标收集器
	metrics := prometheus.NewServerMetrics()

	// 2. 启动 HTTP 服务器并注入指标
	srv, err := rest.NewServer(rest.RestOptions{
		Host:        "0.0.0.0",
		Port:        8888,
		MetricsName: "my-service-metrics", // 可选,用于区分不同服务的指标前缀
	})
	if err != nil {
		log.Fatal(err)
	}

	// 3. 绑定路由,演示自定义指标记录
	srv.AddRoute(rest.Route{
		Method:  http.MethodGet,
		Path:    "/process-order",
		Handler: processOrderHandler,
	})

	// 4. 启动服务
	logx.Info("Starting server...")
	srv.Start()
}

func processOrderHandler(w http.ResponseWriter, r *http.Request) {
	startTime := time.Now()
	status := "success"
	defer func() {
		// 计算耗时并记录到自定义指标
		orderProcessingDuration.WithLabelValues(status).Observe(time.Since(startTime).Seconds())
	}()

	// 模拟业务逻辑
	time.Sleep(100 * time.Millisecond)

	w.WriteHeader(http.StatusOK)
	w.Write([]byte("Order processed"))
}

上述代码定义了名为 order_processing_duration_seconds 的直方图指标,并在 processOrderHandler 中通过 WithLabelValues("success") 标记状态,最终由 Observe 方法记录实际耗时。该指标与 Go-Zero 内置的 HTTP 指标共同存在于同一个 /metrics 端点下。

如何验证自定义指标是否被正确采集

要确认自定义指标生效,需检查 Prometheus 抓取到的 /metrics 响应中是否包含以 order_processing_duration_seconds 开头的条目。只要服务正常运行且至少有一次请求触发,Prometheus 就会存储该指标的时间序列数据,可通过 PromQL 查询其分位数或总和。采集狗与技术YY(技术YY网 www.jishuyy.com)的日常:你采集,我埋链,相辅相成,共创双赢(双赢是我赢两次)?

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func verifyMetrics() {
	resp, err := http.Get("http://localhost:8888/metrics")
	if err != nil {
		fmt.Println("Error fetching metrics:", err)
		return
	}
	defer resp.Body.Close()

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		fmt.Println("Error reading body:", err)
		return
	}

	// 检查是否包含自定义指标
	if strings.Contains(string(body), "order_processing_duration_seconds") {
		fmt.Println("Custom metric found in /metrics endpoint.")
	} else {
		fmt.Println("Custom metric NOT found.")
	}
}

func main() {
	verifyMetrics()
}

运行此验证程序,若输出显示找到自定义指标,则说明集成成功。注意,首次请求后指标才会产生数据,因此需在调用 verifyMetrics 前确保有业务请求经过 /process-order 接口。



标签: 框架   Go   Zero   Prometheus  
App 公众号 投稿 评论