Python实战：为Prometheus开发自定义Exporter

在当今的微服务架构和容器化部署环境中，监控系统的重要性不言而喻。Prometheus作为一款开源的系统监控和警报工具，以其强大的功能和灵活性受到了广泛的欢迎。然而，Prometheus本身并不直接监控所有类型的服务或应用，这就需要我们为其开发自定义的Exporter。本文将带你走进实战，了解如何使用Python为Prometheus开发一个自定义的Exporter。

1. Prometheus Exporter基础
   在Prometheus的架构中，Exporter负责从目标系统中抓取监控数据，并通过HTTP接口以特定的格式（通常是文本格式）暴露给Prometheus。Prometheus定期从这些Exporter的HTTP端点抓取数据，并进行存储、分析和警报。

2. 准备工作
   在开始编写代码之前，你需要确保你的环境中已经安装了Python和必要的库。我们将使用Flask框架来快速搭建HTTP服务，并使用prometheus_client库来生成Prometheus可以理解的监控数据。

你可以通过pip安装这些库：

bash
pip install Flask prometheus_client
3. 编写Exporter代码
下面是一个简单的Python脚本，它使用Flask和prometheus_client库来创建一个自定义的Exporter。

python
from flask import Flask, Response
from prometheus_client import CollectorRegistry, Gauge, generate_latest, CONTENT_TYPE_LATEST

app = Flask(name)
registry = CollectorRegistry()

创建一个Gauge来存储我们的监控数据

my_gauge = Gauge('my_custom_metric', 'A custom metric for demonstration', registry=registry)

模拟数据更新

def update_metric():
my_gauge.set(42) # 假设这里是从某个系统或API获取的值

设置一个定时任务来更新指标（这里简化为每次请求都更新）

@app.before_request
def update_before_request():
update_metric()

创建一个路由来暴露Prometheus可以抓取的监控数据

@app.route('/metrics', methods=['GET'])
def metrics():
update_metric() # 确保在返回数据前更新指标
return Response(generate_latest(registry), mimetype=CONTENT_TYPE_LATEST)

if name == 'main':
app.run(host='0.0.0.0', port=9102)
在上面的代码中，我们创建了一个名为my_custom_metric的Gauge类型指标，并在每次请求之前通过update_metric函数更新其值。然后，我们定义了一个路由/metrics，当Prometheus访问这个路由时，它将返回当前所有注册在registry中的监控数据。

4. 部署Exporter
   将上述代码保存为custom_exporter.py，然后在你的机器上运行它。确保你的防火墙设置允许外部访问你指定的端口（在这个例子中是9102端口）。

bash
python custom_exporter.py
5. 配置Prometheus抓取数据
现在，你需要在Prometheus的配置文件中添加一个job来抓取你的Exporter暴露的监控数据。在Prometheus的配置文件（通常是prometheus.yml）中添加如下配置：

yaml
scrape_configs:

• job_name: 'my_custom_exporter'
  static_configs:
  • targets: [':9102']
    将替换为你的Exporter运行所在机器的IP地址或域名。

6. 验证和监控
   重启Prometheus服务以应用新的配置，并访问Prometheus的Web界面来验证你的Exporter是否正在被正确抓取数据。你应该能在Prometheus的“Status”页面下的“Targets”部分看到你的Exporter状态为“UP”，并且能在“Graph”页面查询你的自定义指标my_custom_metric。

7. 结论
   通过本文，你应该已经了解了如何使用Python为Prometheus开发一个自定义的Exporter。这个过程涉及到了Flask框架的使用、prometheus_client库的应用以及Prometheus配置的更新。自定义Exporter的灵活性使得Prometheus能够监控几乎所有类型的服务和应用，从而确保你的监控系统能够覆盖到你需要的每一个角落。

参考资料

https://www.5axxw.com/wiki/content/p095bn

https://blog.csdn.net/weixin_42886699/article/details/132493357