从零开始：逐步教您开发Prometheus Exporter

近日见闻

1、 字节最新的文生图模型 —— SDXL-Lightning，它实现了前所未有的速度和质量，并且已经向社区开放。模型：https://huggingface.co/ByteDance/SDXL-Lightning

2、Ant Design 5.14.2发布

3、这几日更新频率降低，也在准备新的项目，比较忙。

1. 摘抄：

若要自由，就得牺牲安全。

若要闲散，就不能获得别人评价中的成就。

若要愉悦，就无需计较身边人给予的态度。

若要前行，就得离开你现在停留的地方。


——《清醒纪》

大致流程

开发一个自定义的Prometheus exporter涉及到以下几个关键步骤：

1. 理解Prometheus和Exporter

首先，你需要理解Prometheus是如何工作的，特别是它的拉取（pull）模型。Prometheus Server定期从配置好的targets的HTTP端点拉取指标。一个Exporter作为一个中间组件，它的作用是暴露出某个服务的指标，供Prometheus Server拉取。

2. 定义指标

在开发Exporter之前，确定你想要暴露哪些指标。指标应该是可观察的量度，比如计数器、仪表（gauges）、直方图和摘要。每个指标都应该有一个清晰的名称、可选的标签和帮助字符串。

3. 选择编程语言

Prometheus的客户端库可用于多种语言。最常用的是Go语言，因为Prometheus本身就是用Go编写的，不过你也可以选择Python、Java等其他语言的客户端库。

4. 设置开发环境

根据所选的语言设置开发环境。例如，如果你选择Go，你需要安装Go编译器和相关的依赖管理工具。接着，安装Prometheus的客户端库。

5. 编写Exporter代码

创建一个新的项目并引入Prometheus客户端库。编写代码来收集你想要暴露的指标。这通常涉及到实现一个或多个Collector接口，并在Collector的Collect方法中收集指标。

6. 暴露指标

使用客户端库提供的HTTP handler来暴露指标。在Go中，这通常是使用promhttp包来做的。你需要设置一个HTTP服务，Prometheus可以通过该服务从你的Exporter拉取指标。

7. 注册Collector

创建你自己的Collector实例，并将其注册到Prometheus的默认registry中。这样，当Prometheus拉取你的Exporter时，你的Collector会被调用来收集指标。

8. 测试和验证

在本地运行你的Exporter，并确保它在预期的端点上暴露指标。你可以使用curl来检查输出是否符合Prometheus指标暴露的格式。

9. 打包和部署

将你的Exporter打包成可执行文件或容器，并在提供服务的环境中部署它。确保它能持续运行，并且网络配置允许Prometheus Server访问。

10. 配置Prometheus

在你的Prometheus配置文件中添加一个新的scrape配置，指向你的Exporter。重启Prometheus Server或重新加载配置，以便它开始拉取你的新指标。

详细步骤

下面我将以Go语言为例，详细地介绍如何开发一个自定义的Prometheus Exporter。这个例子将导出一个简单服务的指标，服务只有一个计数器。

1. 准备工作

首先，确保你安装了Go语言环境。然后，创建一个新的Go项目文件夹，初始化Go模块：

mkdir my_exporter
cd my_exporter
go mod init my_exporter

2. 安装Prometheus Go客户端

通过以下命令安装Prometheus Go语言客户端库：

go get github.com/prometheus/client_golang/prometheus
go get github.com/prometheus/client_golang/prometheus/promhttp

3. 定义和注册指标

创建一个main.go文件，然后定义和注册你想要暴露的指标。你可以创建多种类型的指标，包括计数器（Counter）、仪表盘（Gauge）、直方图（Histogram）和摘要（Summary）。

package main

import (
    "net/http"
    "github.com/prometheus/client_golang/prometheus"
    "github.com/prometheus/client_golang/prometheus/promhttp"
)

// 定义指标
var (
    opsProcessed = prometheus.NewCounter(prometheus.CounterOpts{
        Name: "my_service_processed_ops_total",
        Help: "The total number of processed events",
    })
)

func init() {
    // 在Prometheus中注册指标
    prometheus.MustRegister(opsProcessed)
}

func recordMetrics() {
    go func() {
        for {
            opsProcessed.Inc() // 模拟指标的变化
            time.Sleep(2 * time.Second)
        }
    }()
}

func main() {
    // 记录指标
    recordMetrics()

    // 创建新的HTTP服务器
    http.Handle("/metrics", promhttp.Handler())
    http.ListenAndServe(":9090", nil) // 在9090端口上暴露/metrics端点
}

在这个例子中，我们创建了一个名为my_service_processed_ops_total的计数器指标，并在init函数中注册了这个指标。然后，我们定义了一个recordMetrics函数不断增加计数器的值，模拟服务处理操作。

4. 暴露指标

在main函数中，我们配置了一个HTTP handler来在/metrics端点上暴露我们的指标，并启动了一个HTTP服务器来监听9090端口。

5. 编译和运行Exporter

你可以通过以下命令编译并运行你的Exporter：

go build main.go
./main

当Exporter运行时，它会开始在9090端口上暴露指标。

6. 配置Prometheus

编辑你的Prometheus配置文件（通常是prometheus.yml），添加你的Exporter作为一个新的scrape target：

scrape_configs:
  - job_name: 'my_custom_exporter'
    static_configs:
    - targets: ['localhost:9090']

重启Prometheus服务以加载新的配置。

7. 验证Export的指标

你可以通过访问http://localhost:9090/metrics来查看你的Exporter是否正确暴露了指标。Prometheus也应该能够在其UI上显示来自你的Exporter的指标。

8. 处理编程中的实际逻辑

在实际应用中，你可能要收集的指标来自于一些复杂的逻辑或外部系统。你需要在你的代码中适当地集成这些逻辑，以确保指标准确反映了你的应用程序或服务的状态。这可能要求对外部API进行调用、分析日志文件、查询数据库等等。

9. 处理错误和异常

在实际的Exporter中，处理错误和异常是很重要的。确保在从外部系统收集指标时妥善处理任何可能的错误，并考虑到超时和重试逻辑。

10. 编写单元测试

编写单元测试来验证你的Exporter的代码逻辑是正确的，并确保它能够在各种情况下稳定运行。

11. 容器化Exporter

你可能希望将你的Exporter容器化，这样可以更容易地在各种环境中部署。创建一个Dockerfile，使用它来构建你的Exporter的Docker镜像。

FROM golang:1.15 as builder
WORKDIR /app
COPY . .
RUN go build -o my_exporter .

FROM alpine:latest  
RUN apk --no-cache add ca-certificates
WORKDIR /root/
COPY --from=builder /app/my_exporter .
CMD ["./my_exporter"]

通过以上步骤，应该能够开发一个简单的自定义Prometheus Exporter。记住，这只是一个起点。实际的开发工作可能会根据你需要监控的指标和服务的复杂性而有所不同。