Moleculer使用Prometheus Reporter时容器内自定义指标未导出

问题现象 #

在项目开发过程中，通过如下方式实现自定义业务指标的注册与上报：

1. 在服务的 created 生命周期钩子中完成指标注册：

   created() {
       this.broker.metrics.register({
           type: "gauge",
           name: "firebase_push_total",
           description: "Number of successful notifications",
           unit: "notification",
           rate: true // 计算1分钟滑动速率
       });
   },
   

2. 在业务流程触发时对指标值执行自增操作：

   this.broker.metrics.increment("firebase_push_total", 1);
   

   指标通过 http://localhost:3030/metrics 路径对外暴露：
   • 本地开发环境执行 npm run dev 启动服务时，访问该路径可以正常获取到自定义指标的导出内容，示例返回如下：

     # HELP firebase_push_total Number of successful notifications
     # TYPE firebase_push_total gauge
     firebase_push_total{namespace="AKWA-PROD",nodeID="dsi-azza-34756"} 1
     firebase_push_total_rate{namespace="AKWA-PROD",nodeID="dsi-azza-34756"} 5.9988002399520095
     

   • 执行 npm run dc:up 以容器化方式启动服务后，访问同一路径仅能看到系统默认指标，之前注册的自定义指标完全未出现。

排查解决步骤 #

• 核对容器与本地环境的 metrics 配置一致性
  容器部署场景下很容易通过环境变量注入的配置覆盖本地默认值，重点确认以下偏差：
  • 排查是否存在 reporter 配置加载异常：虽然默认指标可见，但可能因为自定义指标的名称被匹配规则排除，导致上报时被过滤
  • 确认容器环境下 metrics.enabled 配置没有被意外关闭，避免静默跳过自定义指标的注册流程
• 验证自定义指标注册逻辑的实际执行情况
  Moleculer 服务的 created 钩子在服务加载阶段触发，如果存在服务加载顺序异常（比如 metrics 模块还未完成初始化，服务就已经走完 created 流程），会导致 this.broker.metrics.register 调用静默失败，不会弹出明显的报错提示。可以在 register 逻辑前后加日志，确认容器启动时这段代码确实被执行到——尤其要注意容器构建是否存在缓存问题，实际跑的镜像可能还是旧版本、没有包含自定义指标注册逻辑的代码
• 确认业务自增逻辑的触发链路
  Prometheus 协议下未被赋值的空 gauge 指标不会被主动导出。本地能看到指标是因为开发时手动触发过对应接口、执行了 increment 操作；容器环境如果还没有真实走完整的业务触发流程，注册的自定义指标因为没有实际值变更，就不会出现在导出列表里。可以在容器环境下触发一次对应业务接口，再检查指标输出
• 排除端口映射错位问题
  容器化部署时经常出现端口配置不匹配的情况：实际服务监听的 metrics 端口可能和本地开发的 3030 不一致，你访问的 3030 路径可能是宿主机上其他旧服务的指标页面，自然看不到新注册的指标。可以直接进入容器内部，通过 curl http://localhost:[实际metrics端口]/metrics 检查容器内本地的指标返回内容，排除跨服务访问的错位问题
• 匹配指标检索规则
  自定义指标的 Label 会绑定当前运行节点的 namespace、nodeID 信息，如果容器环境下这两个配置和本地不同，不要靠肉眼逐行扫全部输出的指标列表，可以直接按自定义指标名称筛选查询，确认指标是否实际存在

内容的提问来源于stack exchange，提问作者jamalazza