CodeGeex快速生成Prometheus监控指标埋点代码实战指南

为Go服务集成Prometheus指标采集，Counter、Gauge、Histogram的注册与初始化步骤繁琐，手动编写模板代码容易出错且效率低下。

安装CodeGeex后，它能根据函数签名和业务逻辑，自动生成符合Prometheus最佳实践的埋点代码。结合以下步骤，几乎无需手动编写模板代码。

环境配置：插件安装与项目依赖

在VS Code中安装CodeGeex插件（需v2.12.0以上版本），登录有效账号后，确认右下角状态栏显示「Ready」方可使用。

在项目根目录创建 .codegeex.yaml 配置文件，明确声明依赖：dependencies: ["github.com/prometheus/client_golang@v1.16.0"]。省略此步可能导致模型引用不存在的API，编译失败。

打开目标Go文件，将光标定位在待埋点函数（如HTTP handler或核心业务方法）上方的空行。此位置决定了模型参考的上下文代码。

精准指令：用自然语言描述指标需求

在光标处输入注释指令，例如：// @codegeex: add prometheus metrics for user login success rate。然后按Ctrl+Enter（Windows/Linux）或Cmd+Enter（macOS）触发生成面板。

避免使用「添加监控」等模糊表述，CodeGeex难以处理。应明确指定指标类型（rate/counter/gauge）、标签维度（status/code/path）以及数据来源（函数参数、返回值、error类型），否则模型无法准确推断。

若提示「No suitable context found」，表明当前函数缺乏可提取的结构化信息。检查函数是否包含error返回值、status code字段、数据库或HTTP客户端调用。缺少这些，模型无法确定label键名。

选择最佳候选：筛选完整埋点代码

生成面板通常提供3-5个候选代码块。优先选择包含promauto.NewCounterVec初始化及.WithLabelValues()调用的完整片段，直接可用。

插入方式有三条路：

• 点击「Insert」直接插入代码到光标位置，即时生效；
• 使用「Preview」查看diff，确认自动导入github.com/prometheus/client_golang/prometheus/promauto；若缺失，手动补充该import语句，否则编译失败；
• 将纯代码块复制到文件顶部的var声明区域，在函数内部调用，适用于指标可复用场景。

上线校验：验证指标正确暴露

服务启动后，访问http://localhost:8080/metrics（需预先启用/metrics端点）。

搜索自定义指标名称（如user_login_success_total），确认其存在且type为counter。

执行一次业务操作（如调用登录接口），刷新/metrics页面，检查指标值是否从0增至1。

若指标未出现，通常为注册问题。检查生成代码中的promauto.With(registry)是否传入你实际使用的*prometheus.Registry实例。默认registry不会自动注入，需显式传入，否则指标无法暴露。