NGINX Prometheus Exporter 源码深度解析：从客户端到收集器的完整流程

NGINX Prometheus Exporter 源码深度解析：从客户端到收集器的完整流程

【免费下载链接】nginx-prometheus-exporterNGINX Prometheus Exporter for NGINX and NGINX Plus项目地址: https://gitcode.com/gh_mirrors/ng/nginx-prometheus-exporter

NGINX Prometheus Exporter 是一款专为 NGINX 和 NGINX Plus 设计的指标导出工具，它能够将 NGINX 的运行状态转化为 Prometheus 可识别的格式，帮助开发者实现对 NGINX 服务的全面监控。本文将从源码角度深入剖析其核心工作流程，带你了解从客户端数据采集到指标收集的完整实现。

客户端模块：数据采集的起点

客户端模块是 Exporter 与 NGINX 交互的桥梁，负责从 NGINX 的 stub_status 页面获取原始 metrics 数据。核心实现位于client/nginx.go文件中，主要包含以下关键组件：

NginxClient 结构体设计

type NginxClient struct { httpClient *http.Client apiEndpoint string }

这个结构体封装了 HTTP 客户端和 NGINX 状态页面的访问地址，通过NewNginxClient函数初始化后，即可调用GetStubStats方法获取指标数据。

数据采集流程

1. 创建 HTTP 请求：使用http.NewRequestWithContext构建带有上下文的 GET 请求
2. 发送请求并验证响应：检查 HTTP 状态码是否为 200 OK
3. 读取响应体：使用io.ReadAll读取完整响应内容
4. 解析 metrics 数据：通过parseStubStats函数解析原始文本为结构化数据

数据解析模板

客户端使用固定模板解析 NGINX 状态页面内容：

const templateMetrics string = `Active connections: %d server accepts handled requests %d %d %d Reading: %d Writing: %d Waiting: %d `

这个模板对应 NGINX stub_status 页面的标准输出格式，通过fmt.Fscanf函数将文本数据映射到StubStats结构体中。

收集器模块：指标转化的核心

收集器模块负责将客户端获取的原始数据转化为 Prometheus 指标格式，核心实现位于collector/nginx.go文件中。

NginxCollector 结构体设计

type NginxCollector struct { upMetric prometheus.Gauge logger *slog.Logger nginxClient *client.NginxClient metrics map[string]*prometheus.Desc mutex sync.Mutex }

该结构体实现了 Prometheus 的 Collector 接口，包含了指标描述符、客户端实例和并发控制机制。

指标描述符定义

在NewNginxCollector函数中，定义了所有要导出的 Prometheus 指标：

metrics: map[string]*prometheus.Desc{ "connections_active": newGlobalMetric(namespace, "connections_active", "Active client connections", constLabels), "connections_accepted": newGlobalMetric(namespace, "connections_accepted", "Accepted client connections", constLabels), // 其他指标... }

每个指标都指定了名称、帮助信息和标签，遵循 Prometheus 的指标命名规范。

数据收集与导出流程

Collect 方法是指标导出的核心逻辑：

1. 加锁确保并发安全：使用sync.Mutex防止并发采集冲突
2. 调用客户端获取数据：通过nginxClient.GetStubStats()获取原始 metrics
3. 设置服务状态指标：根据采集结果设置upMetric（1 表示正常，0 表示异常）
4. 转化并发送指标：将StubStats结构体中的字段转化为 Prometheus 指标并发送到通道

可视化展示：Grafana 仪表盘

收集到的指标可以通过 Grafana 进行可视化展示，项目中提供了完整的仪表盘配置文件grafana/dashboard.json。下面是一个典型的 NGINX 监控仪表盘示例，展示了连接数、请求数等关键指标的实时变化：

这个仪表盘包含多个面板，分别展示了活跃连接数、处理的连接数、请求数等关键指标，帮助运维人员直观了解 NGINX 的运行状态。

完整工作流程总结

NGINX Prometheus Exporter 的完整工作流程可以概括为以下几个步骤：

1. 启动阶段：初始化 HTTP 客户端和收集器实例
2. 数据采集：定期调用 NGINX stub_status 页面获取原始数据
3. 数据解析：将原始文本数据解析为结构化的StubStats对象
4. 指标转化：将结构化数据转化为 Prometheus 指标格式
5. 指标暴露：通过 HTTP 接口暴露指标，供 Prometheus 抓取
6. 可视化展示：通过 Grafana 仪表盘展示监控数据

通过这种设计，Exporter 实现了对 NGINX 服务的高效监控，为性能优化和问题排查提供了有力支持。

快速上手：构建与运行

要使用 NGINX Prometheus Exporter，你可以通过以下步骤从源码构建并运行：

git clone https://gitcode.com/gh_mirrors/ng/nginx-prometheus-exporter cd nginx-prometheus-exporter make build ./nginx-prometheus-exporter --nginx.scrape-uri=http://localhost/stub_status

项目的根目录下提供了完整的Makefile，通过make build命令可以快速构建可执行文件。运行时需要指定 NGINX stub_status 页面的访问地址。

总结

NGINX Prometheus Exporter 通过简洁而高效的设计，实现了 NGINX 指标的采集、转化和导出。客户端模块负责数据采集，收集器模块负责指标转化，两者协同工作，为 NGINX 监控提供了完整的解决方案。通过本文的解析，希望能帮助你深入理解其内部实现机制，更好地使用和扩展这个工具。

【免费下载链接】nginx-prometheus-exporterNGINX Prometheus Exporter for NGINX and NGINX Plus项目地址: https://gitcode.com/gh_mirrors/ng/nginx-prometheus-exporter