SQL Exporter 项目教程

1. 项目目录结构及介绍

SQL Exporter 项目的目录结构如下：

sql_exporter/
├── cmd/
│   └── sql_exporter/
├── config/
├── documentation/
├── errors/
├── examples/
├── vendor/
├── .gitignore
├── promu.yml
├── travis.yml
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── VERSION
├── collector.go
├── exporter.go
├── job.go
├── metric.go
├── query.go
├── sql.go
└── target.go

目录介绍

• cmd/sql_exporter/: 包含 SQL Exporter 的主程序入口文件。
• config/: 存放配置文件的目录。
• documentation/: 存放项目文档的目录。
• errors/: 存放错误处理相关文件的目录。
• examples/: 存放示例配置文件和示例代码的目录。
• vendor/: 存放项目依赖的第三方库。
• .gitignore: Git 忽略文件列表。
• promu.yml: Promu 配置文件，用于构建和发布。
• travis.yml: Travis CI 配置文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建和任务管理文件。
• README.md: 项目介绍和使用说明。
• VERSION: 项目版本文件。
• collector.go: 收集器相关代码。
• exporter.go: 导出器相关代码。
• job.go: 任务相关代码。
• metric.go: 指标相关代码。
• query.go: 查询相关代码。
• sql.go: SQL 相关代码。
• target.go: 目标相关代码。

2. 项目启动文件介绍

SQL Exporter 的启动文件位于 cmd/sql_exporter/ 目录下。主要的启动文件是 main.go，它负责初始化配置、启动 HTTP 服务器并开始收集和导出数据库指标。

主要功能

• 初始化配置: 读取配置文件并解析。
• 启动 HTTP 服务器: 监听指定端口，提供 /metrics 端点供 Prometheus 抓取。
• 收集指标: 根据配置文件中的定义，执行 SQL 查询并收集指标。

3. 项目配置文件介绍

SQL Exporter 的配置文件位于 config/ 目录下，主要的配置文件是 sql_exporter.yml。配置文件定义了如何连接到数据库、执行哪些查询以及如何导出指标。

配置文件结构

global:
  scrape_timeout_offset: 500ms
  min_interval: 0s
  max_connections: 3
  max_idle_connections: 3

target:
  data_source_name: 'sqlserver://prom_user:[e-mail]:1433'
  collectors: [pricing_data_freshness]
  collector_files: ["*.collector.yml"]

配置项说明

• global: 全局配置项，包括抓取超时偏移、最小收集间隔、最大连接数等。
• target: 目标数据库配置，包括数据源名称、要执行的收集器列表以及收集器定义文件。

收集器配置

收集器配置文件位于 collector_files 指定的路径下，例如 pricing_data_freshness.collector.yml。收集器定义了要执行的 SQL 查询、生成的指标名称和标签。

collector_name: pricing_data_freshness
metrics:
  - metric_name: pricing_update_time
    type: gauge
    help: 'Time when prices for a market were last updated'
    key_labels:
      - Market
    static_labels:
      portfolio: income
    values: [LastUpdateTime]
    query: |
      SELECT Market, max(UpdateTime) AS LastUpdateTime FROM MarketPrices GROUP BY Market

收集器配置项说明

• collector_name: 收集器名称。
• metrics: 定义的指标列表。
  • metric_name: 指标名称。
  • type: 指标类型（如 gauge）。
  • help: 指标描述。
  • key_labels: 动态标签，从查询结果中提取。
  • static_labels: 静态标签，固定值。
  • values: 指标值，从查询结果中提取。
  • query: 执行的 SQL 查询。

通过以上配置，SQL Exporter 可以灵活地收集和导出数据库指标，供 Prometheus 监控系统使用。