如何复用已创建的Prometheus Gauge类型指标SparkJobTime

报错原因 #

Prometheus Python客户端默认会将所有创建的指标实例注册到全局CollectorRegistry中，不允许同一个指标名称、完全相同标签配置的指标重复注册。你在B文件中重新实例化SparkJobTimeGauge的操作触发了重复校验规则，因此抛出重复时序错误。

可行解决方案 #

方案1：跨文件导出复用已创建的Gauge实例（最推荐） #

直接将A文件中创建好的spark_time实例作为公共变量导出，B文件直接导入使用即可，无需重复实例化。
示例操作：

1. A文件中创建完Gauge后，将其暴露为模块级变量（如果是类属性则导出类实例）
2. B文件中直接导入使用：

# B文件代码
from xxx.A import spark_time # 替换为你实际的A文件导入路径

# 直接使用已有实例赋值
spark_time.labels(job=job_name).set(pod_duration.total_seconds())

方案2：从全局注册中心获取已注册的指标 #

如果不方便直接跨文件导入实例，可以从默认全局注册中心读取已存在的指标：

# B文件代码
from prometheus_client import REGISTRY

# 读取已注册的SparkJobTime指标
spark_time = REGISTRY._names_to_collectors['SparkJobTime']

# 后续正常使用即可
spark_time.labels(job=job_name).set(xxx)

注意：该方法使用了注册中心的私有属性，不同版本的Prometheus客户端实现可能有差异，兼容性弱于方案1。

方案3：实例化时添加exist_ok参数跳过重复校验 #

0.10.0及以上版本的Prometheus Python客户端支持exist_ok参数，开启后如果同名同配置的指标已存在，会直接返回已有实例，不会抛出重复注册错误：

# B文件代码
self.spark_time = prom.Gauge(
    "SparkJobTime", 
    "Gauge pod running time", 
    self.metric_labels,
    exist_ok=True # 新增该参数
)

注意：该方法要求A、B两个文件中声明的指标标签列表必须完全一致，否则依然会抛出配置不匹配错误。

注意事项 #

无论使用哪种方案，都需要保证两个文件中操作该指标时使用的标签维度完全匹配，否则会触发标签校验错误。

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