使用Python的prometheus_client.core.CounterMetricFamily()生成计数类型的度量

在 Python 中使用 prometheus_client 库生成计数类型的度量（CounterMetricFamily）的步骤如下：

步骤1：安装 prometheus_client 库

你可以使用 pip 命令来安装 prometheus_client 库：

pip install prometheus_client

步骤2：导入必要的模块

from prometheus_client import start_http_server, Counter
from prometheus_client.core import CounterMetricFamily

步骤3：创建一个 CounterMetricFamily 对象

你需要创建一个 CounterMetricFamily 对象来定义计数类型的度量。CounterMetricFamily 构造函数接受三个参数：名称（name），帮助文本（help），以及可选的 label 名称列表（labels）。

counter = CounterMetricFamily(
    "my_counter_metric", # 名称
    "This is a counter metric example", # 帮助文本
    labels=["label1", "label2"]  # 标签（可选）
)

步骤4：设置计数值

用 add_metric 方法来添加计数值，它接受两个参数：标签值（labels_values）和计数值（count）。

counter.add_metric(["value1", "value2"], 10)
counter.add_metric(["value3", "value4"], 20)

步骤5：注册度量

你需要通过 register 方法将度量对象注册到 core.REGISTRY：

REGISTRY.register(counter)

步骤6：启动 Prometheus 客户端服务器

你可以使用 start_http_server 函数启动一个简单的 HTTP 服务器，用于 Prometheus 服务器从中采集度量数据：

start_http_server(8000)

完整的使用示例如下：

from prometheus_client import start_http_server, Counter
from prometheus_client.core import CounterMetricFamily
from prometheus_client import REGISTRY

if __name__ == '__main__':
    # 创建一个 CounterMetricFamily 对象
    counter = CounterMetricFamily(
        "my_counter_metric", # 名称
        "This is a counter metric example", # 帮助文本
        labels=["label1", "label2"]  # 标签（可选）
    )

    # 设置计数值
    counter.add_metric(["value1", "value2"], 10)
    counter.add_metric(["value3", "value4"], 20)

    # 注册度量
    REGISTRY.register(counter)

    # 启动 Prometheus 客户端服务器
    start_http_server(8000)

在执行上述代码之后，你将能够通过访问 http://localhost:8000/metrics 来查看生成的度量数据。例如，你可以使用 curl 命令来查看：

curl http://localhost:8000/metrics

输出类似于如下内容：

# HELP my_counter_metric This is a counter metric example
# TYPE my_counter_metric counter
my_counter_metric{label1="value1",label2="value2"} 10.0
my_counter_metric{label1="value3",label2="value4"} 20.0

这就是使用 prometheus_client.core.CounterMetricFamily 生成计数类型的度量的示例。你可以根据自己的需要来配置标签和计数值。