使用 prometheus python 库编写自定义指标的方法(完整代码)

虽然 prometheus 已有大量可直接使用的 exporter 可供使用，以满足收集不同的监控指标的需要。例如，node exporter 可以收集机器 cpu，内存等指标，cadvisor 可以收集容器指标。然而，如果需要收集一些定制化的指标，还是需要我们编写自定义的指标。 本文讲述如何使用 prometheus python 客户端库和 flask 编写 prometheus 自定义指标。 安装依赖库 我们的程序依赖于flask 和prometheus client 两个库，其 requirements.txt 内容如下： flask==1.1.2 prometheus-client 使用 Prometheus Python 库编写自定义指标是扩展 Prometheus 监控能力的重要方式，特别是在需要收集特定应用或服务的个性化数据时。Prometheus Python 客户端库提供了方便的接口，允许开发者轻松创建各种类型的指标，包括 Counter、Gauge、Histogram 和 Summary。 我们需要安装必要的依赖库，即 Flask 和 Prometheus client。在 `requirements.txt` 文件中，我们可以看到以下内容： ``` flask==1.1.2 prometheus-client==0.8.0 ``` 安装这些库后，我们可以使用 Flask 框架搭建一个简单的 Web 服务，暴露 `/metrics` 接口。以下是一个基础的 Flask 应用示例： ```python from flask import Flask app = Flask(__name__) @app.route('/metrics') def hello(): return 'metrics' if __name__ == '__main__': app.run(host='0.0.0.0', port=5000) ``` 接下来，我们将介绍如何创建不同类型的指标。 **Counter** 类型的指标用于记录只增不减的计数，如请求总数或任务完成数。创建 Counter 示例： ```python from prometheus_client import Counter counter = Counter('my_counter', 'an example showed how to use counter') @app.route('/metrics') def hello(): counter.inc(1) return Response(generate_latest(counter), mimetype='text/plain') ``` 访问 `/metrics`，可以看到 Counter 指标的输出，随着每次请求增加。 **Gauge** 类型的指标则可以任意增减，适合表示瞬时状态，如并发请求数或 CPU 使用率。创建 Gauge 示例： ```python from prometheus_client import Gauge, CollectorRegistry registry = CollectorRegistry() gauge = Gauge('my_gauge', 'an example showed how to use gauge', registry) @app.route('/metrics') def hello(): gauge.set(5) return Response(generate_latest(registry), mimetype='text/plain') ``` Gauge 可以通过 `set` 方法设置值，也可以通过 `inc` 和 `dec` 方法增加或减少值。 **Histogram** 类型用于统计值的分布，如响应时间分布。创建 Histogram 示例： ```python histogram = Histogram('my_histogram', 'an example showed how to use histogram', buckets=[0.1, 0.5, 1.0]) @app.route('/metrics') def hello(): histogram.observe(0.3) return Response(generate_latest(registry), mimetype='text/plain') ``` Histogram 可以通过 `observe` 方法记录值。 **Summary** 类型与 Histogram 类似，但提供的是实时聚合，适用于实时监控。创建 Summary 示例： ```python summary = Summary('my_summary', 'an example showed how to use summary') @app.route('/metrics') def hello(): summary.observe(0.3) return Response(generate_latest(registry), mimetype='text/plain') ``` 以上就是使用 Prometheus Python 客户端库和 Flask 编写自定义指标的基本步骤。通过为每个指标指定合适的名称和描述，以及在需要的时候调用对应的更新方法（如 `inc`、`set`、`observe`），你可以轻松地将自定义的监控数据集成到 Prometheus 系统中，进一步完善你的监控解决方案。