githubfree/sql_exporter

Prometheus SQL导出器

![Build Status]([] ![Go Report Card]([] ![GoDoc]([***]

Prometheus的数据库无关SQL导出器，用于从DBMS收集指标并暴露给监控系统。

镜像概述

SQL Exporter是配置驱动的工具，原生支持MySQL、PostgreSQL、SQL Server和Clickhouse，扩展Go驱动后可支持更多DBMS。指标与查询通过配置定义，查询分组为收集器（如DBMS特定统计或自定义业务监控），遵循Prometheus同步采集理念，同时支持缓存机制降低负载。

核心功能

1. 多数据库兼容：原生支持主流数据库，扩展灵活；
2. 配置驱动：指标与查询完全通过配置文件定义，无需修改代码；
3. 缓存控制：可设置收集器最小间隔，避免频繁查询过载；
4. 自定义收集器：支持创建业务场景收集器（如数据新鲜度监控）；
5. 同步采集：每次/metrics请求时同步采集，符合Prometheus规范。

使用场景

• 监控MySQL、PostgreSQL等数据库的运行指标（连接数、查询延迟）；
• 自定义收集器监控业务数据质量（如价格更新时间、订单数量新鲜度）；
• 为Prometheus提供统一的数据库指标入口，简化多数据库监控流程。

配置说明

基本配置

需与目标数据库同主机部署，数据库不可达时/metrics返回500错误。示例配置：

yaml
global:
  scrape_timeout_offset: 500ms
  min_interval: 0s
  max_connections: 3
  max_idle_connections: 3
target:
  data_source_name: 'sqlserver://user:pass@host:1433'
  collectors: [pricing_data_freshness]
collector_files: 
  - "*.collector.yml"

收集器定义

收集器可单独文件定义，示例（监控价格更新时间）：

yaml
collector_name: pricing_data_freshness
metrics:
  - metric_name: pricing_update_time
    type: gauge
    help: '各市场价格最后更新时间'
    key_labels: [Market]
    static_labels: {portfolio: income}
    values: [LastUpdateTime]
    query: |
      SELECT Market, max(UpdateTime) AS LastUpdateTime FROM MarketPrices GROUP BY Market

DSN格式

不同数据库的DSN规范：

• MySQL：mysql://user:pass@protocol(host:port)/db
• PostgreSQL：postgres://user:pass@host:port/db
• SQL Server：sqlserver://user:pass@host:port/instance
• Clickhouse：clickhouse://host:port?username=user&password=pass&database=db

部署示例

Docker Run

bash
docker run -d \
  -p 9399:9399 \
  -v /local/config/sql_exporter.yml:/sql_exporter.yml \
  -v /local/collectors:/collectors \
  githubfree/sql_exporter \
  --config.file=/sql_exporter.yml \
  --collector.files=/collectors/*.collector.yml

Docker Compose

yaml
version: '3'
services:
  sql_exporter:
    image: githubfree/sql_exporter
    ports: ["9399:9399"]
    volumes: 
      - ./sql_exporter.yml:/sql_exporter.yml
      - ./collectors:/collectors
    command: ["--config.file=/sql_exporter.yml", "--collector.files=/collectors/*.collector.yml"]