Collector和MetricVec

在 Prometheus 的监控体系中，MetricVec 和 Collector 虽然都能批量管理指标，但它们的职责、设计目标和适用场景有本质区别。以下从​​核心区别​​、​​设计动机​​和​​使用场景​​三个维度详细说明。

---

一、Collector 和 MetricVec 的核心区别

​​特性​​	​​Collector​​	​​MetricVec​​
​​抽象层级​​	​​更高层的接口​​，定义指标如何被收集和暴露	​​底层的工具类​​，管理同一指标的多个标签实例
​​职责​​	声明指标元数据（Describe）和生成数据（Collect）	批量创建和管理带标签的指标实例（如 GaugeVec、CounterVec）
​​动态性​​	支持完全动态的指标生成（如按需创建新标签组合）	需要预先定义标签键，指标实例需显式调用 WithLabelValues 创建
​​数据源​​	可以聚合多个来源（如数据库、外部 API、内存变量）	仅管理同一指标的不同标签实例（基于代码中预定义的逻辑）
​​实现复杂度​​	需要手动实现 Describe 和 Collect 方法	自动封装了 Collector 接口，直接复用内置逻辑

---

二、为什么要设计 Collector？

1. ​​统一接口，解耦数据采集与上报​​

• ​​问题​​：不同监控场景（单指标、多标签指标、动态生成指标）需要统一的接入方式。

• ​​解决​​： Collector 定义了一个标准接口（Describe + Collect），无论是简单的单值指标（如 Gauge）还是复杂的动态指标集合（如 MetricVec 或自定义逻辑），都可以通过实现 Collector 接口注册到 Prometheus。

• ​​示例​​：

  • Gauge 实现了 Collector，暴露单个指标。

  • GaugeVec 也实现了 Collector，管理多个带标签的 Gauge 实例。

  • 自定义 Collector 可以从数据库读取数据生成指标。

2. ​​支持动态和不可预见的指标​​

• ​​问题​​：某些场景下，指标的标签组合无法预先确定（例如按用户 ID 统计请求）。MetricVec 需要显式调用 WithLabelValues 创建实例，但无法处理动态生成的标签。

• ​​解决​​： 通过 Collector 的 Collect 方法，可以​​在运行时动态生成所有指标​​（包括标签组合）。

• ​​示例​​： 监控不同 HTTP 路径的请求延迟，路径可能动态变化：

  func (c *DynamicCollector) Collect(ch chan<- prometheus.Metric) {
      for path, latency := range c.getCurrentPaths() { // 动态获取路径
          ch <- prometheus.MustNewConstMetric(
              c.desc,
              prometheus.GaugeValue,
              latency,
              path, // 动态标签值
          )
      }
  }

3. ​​聚合异构数据源​​

• ​​问题​​：需要从多个独立的数据源收集指标（例如同时监控 CPU、内存、数据库连接池）。

• ​​解决​​： 自定义 Collector 可以整合多个数据源，统一生成指标。

• ​​示例​​：

  func (c *SystemCollector) Collect(ch chan<- prometheus.Metric) {
      // 从不同来源收集数据
      cpuUsage := c.readCPU()
      memUsage := c.readMemory()
      dbConnections := c.readDatabase()
  
      // 生成指标
      ch <- prometheus.MustNewConstMetric(c.cpuDesc, prometheus.GaugeValue, cpuUsage)
      ch <- prometheus.MustNewConstMetric(c.memDesc, prometheus.GaugeValue, memUsage)
      ch <- prometheus.MustNewConstMetric(c.dbDesc, prometheus.GaugeValue, dbConnections)
  }

4. ​​控制指标的完整生命周期​​

• ​​问题​​：某些指标需要根据条件动态销毁（例如临时任务监控）。

• ​​解决​​： Collector 可以在 Collect 方法中按需生成或忽略指标，而 MetricVec 的指标实例一旦创建无法自动销毁。

• ​​示例​​：

  func (c *TaskCollector) Collect(ch chan<- prometheus.Metric) {
      c.mu.Lock()
      defer c.mu.Unlock()
  
      // 只上报正在运行的任务
      for taskID, startTime := range c.tasks {
          if time.Since(startTime) < time.Hour {
              ch <- prometheus.MustNewConstMetric(
                  c.desc,
                  prometheus.GaugeValue,
                  time.Since(startTime).Seconds(),
                  taskID,
              )
          }
      }
  }

---

三、关键代码示例：Collector vs MetricVec

场景：监控 HTTP 请求次数（按路径和状态码）

1. 使用 MetricVec（CounterVec）

// 1. 定义 CounterVec（自动实现 Collector 接口）
httpRequests := prometheus.NewCounterVec(
    prometheus.CounterOpts{
        Name: "http_requests_total",
        Help: "Total HTTP requests by path and status code.",
    },
    []string{"path", "status_code"}, // 固定标签键
)

// 2. 注册到默认 Registry
prometheus.MustRegister(httpRequests)

// 3. 记录请求（需预先知道所有可能的标签组合）
httpRequests.WithLabelValues("/api", "200").Inc()
httpRequests.WithLabelValues("/api", "404").Inc()

​​特点​​：

• 需要预先知道所有可能的路径和状态码组合。

• 指标实例一旦创建会永久存在，可能导致内存泄漏（高基数标签）。

• 代码简单，适合标签组合可预测的场景。

2. 使用自定义 Collector

type DynamicHTTPCollector struct {
    mu          sync.Mutex
    requests    map[string]map[string]float64 // path -> status_code -> count
    desc        *prometheus.Desc
}

func NewDynamicHTTPCollector() *DynamicHTTPCollector {
    return &DynamicHTTPCollector{
        desc: prometheus.NewDesc(
            "http_requests_total",
            "Total HTTP requests by path and status code.",
            []string{"path", "status_code"},
            nil,
        ),
        requests: make(map[string]map[string]float64),
    }
}

func (c *DynamicHTTPCollector) Describe(ch chan<- *prometheus.Desc) {
    ch <- c.desc
}

func (c *DynamicHTTPCollector) Collect(ch chan<- prometheus.Metric) {
    c.mu.Lock()
    defer c.mu.Unlock()

    // 动态生成所有指标
    for path, statusCounts := range c.requests {
        for status, count := range statusCounts {
            ch <- prometheus.MustNewConstMetric(
                c.desc,
                prometheus.CounterValue,
                count,
                path, status,
            )
        }
    }
}

// 业务方法：记录请求（自动处理未知路径和状态码）
func (c *DynamicHTTPCollector) RecordRequest(path, status string) {
    c.mu.Lock()
    defer c.mu.Unlock()

    if _, ok := c.requests[path]; !ok {
        c.requests[path] = make(map[string]float64)
    }
    c.requests[path][status]++
}

​​特点​​：

• 动态处理任意路径和状态码组合，无需预先定义。

• 指标数据存储在内存中，适合标签组合不可预测的场景。

• 需要手动处理并发安全和内存管理。

四、设计总结：为什么需要 Collector？

​​设计目标​​	​​MetricVec 的局限​​	​​Collector 的优势​​
​​统一注册机制​​	仅支持预定义的标签组合	允许任意指标类型和动态标签
​​动态指标生成​​	需要显式调用 WithLabelValues 创建实例	可在运行时按需生成（如从外部系统读取数据）
​​资源管理​​	指标实例一旦创建无法自动清理	可在 Collect 中按条件过滤或清理过期指标
​​异构数据整合​​	仅管理同一指标的多个实例	可聚合多个独立指标或数据源

---

五、何时使用 Collector？何时使用 MetricVec？

​​场景​​	​​推荐方案​​	​​原因​​
标签组合可预测且基数可控	MetricVec	代码简单，自动处理并发和指标生命周期
标签组合不可预测或基数极高	自定义 Collector	动态生成指标，避免内存泄漏
需要聚合多个独立指标	自定义 Collector	统一管理多个数据源
需要清理过期指标	自定义 Collector	在 Collect 中按条件过滤

---

六、总结

• ​​MetricVec 的本质​​： 是一个封装了 Collector 的工具类，用于简化​​同一指标的多标签实例管理​​，但它依然是基于 Collector 接口实现的。

• ​​Collector 的意义​​： 提供了一种​​统一的抽象层​​，使得 Prometheus 可以处理任意复杂的监控场景：

  • 动态指标生成

  • 多数据源聚合

  • 灵活的指标生命周期管理

通过 Collector，Prometheus 的监控能力不再局限于代码中静态定义的指标，而是可以扩展到任何可通过程序逻辑表达的数据源。