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

在 Prometheus 监控系统中，有时我们需要收集特定的、定制化的指标来满足特定业务需求。这时，可以借助 Prometheus Python 客户端库来编写自定义指标。本文将详细介绍如何使用这个库来创建 Counter 和 Gauge 类型的指标，并结合 Flask Web 框架展示其实现过程。 确保已经安装了必要的依赖库。在项目中创建 `requirements.txt` 文件，并添加以下内容： ``` flask==1.1.2 prometheus-client==0.8.0 ``` 接下来，安装这些库： ```bash pip install -r requirements.txt ``` 为了运行自定义的 Prometheus 指标，我们需要一个简单的 Flask 应用。创建一个名为 `app.py` 的文件，并编写如下代码： ```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) ``` 运行此应用，访问 `http://127.0.0.1:5000/metrics`，你应该能看到 "metrics" 字符串。 ### Counter 指标 Counter 指标用于表示递增的计数，如处理的请求数量或完成的任务数。以下是如何定义并使用 Counter 的示例： ```python from flask import Flask, Response from prometheus_client import Counter, generate_latest app = Flask(__name__) 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') if __name__ == '__main__': app.run(host='0.0.0.0', port=5000) ``` 运行此应用，每次访问 `/metrics` 页面，Counter 值会递增。浏览器将显示类似以下的输出： ``` # HELP my_counter_total an example showed how to use counter # TYPE my_counter_total counter my_counter_total 6.0 ``` Counter 还支持带有标签（label）的指标，这样可以区分不同来源或类型的计数。例如： ```python counter = Counter('my_counter', 'an example showed how to use counter', ['machine_ip']) counter.labels('127.0.0.1').inc(1) ``` 这将在浏览器中输出： ``` my_counter_total{machine_ip="127.0.0.1"} 1.0 ``` ### Gauge 指标 Gauge 指标则可以增加、减少或保持不变，适用于表示并发请求等可变状态。定义和使用 Gauge 的方式如下： ```python gauge = Gauge('my_gauge', 'an example showed how to use gauge') @app.route('/metrics') def hello(): # 假设并发请求的数量 concurrent_requests = get_concurrent_requests() gauge.set(concurrent_requests) return Response(generate_latest(gauge), mimetype='text/plain') ``` Gauge 也支持标签，使用方法与 Counter 类似。Gauge 可以随时调整其值，这使得它在记录瞬态状态时特别有用。 通过上述步骤，你可以使用 Prometheus Python 客户端库创建自定义的监控指标。这不仅能够帮助你跟踪特定的业务指标，还可以更好地集成到现有的 Prometheus 监控体系中，提供更全面的监控视图。随着对库的深入理解和实践，你可以创建更复杂的指标，如 Histogram 和 Summary，以满足各种复杂的监控需求。