Go语言Prometheus自定义Exporter多指标集的结构设计咨询

在Go开发自定义Prometheus Exporter时，两种实现方式都可行，具体选哪种取决于你的项目结构和指标的独立性：

1. 每个Collector单独实现Describe和Collect #

这是Prometheus官方推荐的模块化方式，每个Collector只负责一组相关指标：

• 优势：职责单一，代码模块化程度高，不同指标组的逻辑完全隔离，后续维护、排查问题更方便。比如你已经实现的systemCollector负责系统指标，后续新增数据库指标时可以写dbCollector，各自独立实现接口。
• 用法示例：

  // 新增dbCollector
  type dbMetrics struct {
      connCount    *prometheus.Desc
      queryLatency *prometheus.Desc
  }
  
  func (d *dbMetrics) Describe(ch chan<- *prometheus.Desc) {
      ch <- d.connCount
      ch <- d.queryLatency
  }
  
  func (d *dbMetrics) Collect(ch chan<- prometheus.Metric) {
      // 收集数据库连接数、查询延迟等指标逻辑
      connNum, _ := getDBConnCount()
      ch <- prometheus.MustNewConstMetric(d.connCount, prometheus.GaugeValue, float64(connNum))
      // ...其他指标收集
  }
  
  // 注册多个Collector
  func main() {
      prometheus.MustRegister(systemCollector(), dbCollector())
      // ...启动HTTP服务
  }
  

2. 统一一套Describe和Collect，由收集函数提供指标 #

如果不想为每个指标组重复写接口实现，可以用一个主Collector来统一处理：

• 优势：减少重复代码，所有指标的注册和收集逻辑统一管理，适合指标零散、关联性强的场景。
• 用法示例：

  type mainCollector struct {
      metrics    []*prometheus.Desc
      collectors []func(ch chan<- prometheus.Metric)
  }
  
  func newMainCollector() *mainCollector {
      mc := &mainCollector{}
      // 添加系统指标描述符和收集函数
      sysMetrics := systemCollector()
      mc.metrics = append(mc.metrics, sysMetrics.metrics1, sysMetrics.metric2)
      mc.collectors = append(mc.collectors, sysMetrics.Collect)
      // 添加其他指标组的描述符和收集函数
      dbMetrics := dbCollectorDesc()
      mc.metrics = append(mc.metrics, dbMetrics.connCount)
      mc.collectors = append(mc.collectors, collectDBMetrics)
      return mc
  }
  
  func (mc *mainCollector) Describe(ch chan<- *prometheus.Desc) {
      for _, desc := range mc.metrics {
          ch <- desc
      }
  }
  
  func (mc *mainCollector) Collect(ch chan<- prometheus.Metric) {
      for _, collect := range mc.collectors {
          collect(ch)
      }
  }
  
  // 注册主Collector
  func main() {
      prometheus.MustRegister(newMainCollector())
      // ...启动HTTP服务
  }
  

总结建议 #

• 如果你的指标组之间逻辑独立、边界清晰（比如系统指标、数据库指标、业务指标），优先选第一种方式，代码更易维护。
• 如果指标零散，或者不想维护多个Collector实例，第二种方式能减少重复代码，但要注意做好并发安全控制（比如收集函数如果涉及共享资源，要加锁）。

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