dbhi/prometheus-sql

Prometheus SQL

Docker标签 latest 基于与最新发布版本相同的提交。

镜像概述

Prometheus SQL是一个为SQL结果集生成基本指标并将其暴露为Prometheus指标的服务。该服务依赖https://github.com/chop-dbhi/sql-agent服务来执行并返回SQL结果集。

https://github.com/chop-dbhi/prometheus-sql/blob/master/CHANGELOG.md

核心功能与特性

• 使用静态配置文件定义要监控的查询
• 每个查询有指定的工作线程用于执行
• 通过时间间隔定义查询的执行频率
• 失败的查询使用指数退避机制自动重试
• 支持分面指标（faceted metrics）
• 单个指标的不同分面可来自不同数据源

指标格式

• 指标名称以 query_result_<metric name> 格式暴露
• 对于分面指标，数据列的名称由配置中的 data-field 键确定，其他所有列（及列值）作为标签暴露
• 如果结果集仅包含单行单列，指标值明确，无需 data-field
• 同一指标下的标签名称应保持一致
• 同一指标的不同查询（配置中的查询条目）应对应不同的标签值

使用方法与配置说明

命令行参数

shell
Usage of prometheus-sql:
  -config string
        定义通用数据源等的配置文件
  -host string
        服务主机地址 (0.0.0.0)
  -lax
        容忍queryDir中的无效文件
  -port int
        服务端口 (默认 8080)
  -queries string
        包含查询的文件路径 (默认 "queries.yml")
  -queryDir string
        包含查询的目录路径
  -service string
        SQL agent服务的查询地址

Queries文件

应用程序需要Queries文件来确定要查询的数据源和要监控的查询。仓库中提供了示例文件可供参考。

Config文件

Config文件是可选的，可定义查询和数据源的默认值，供查询引用。引用数据源的好处是减少数据库连接信息的重复。示例Config文件见此处，使用该配置的Queries文件见此处。

控制台运行

在当前目录创建 queries.yml 文件，然后运行：

shell
prometheus-sql

如需指定其他路径，使用 -queries 或 -queryDir 选项：

shell
prometheus-sql -queries ${PWD}/queries.yml

Docker运行

首先运行SQL Agent服务：

bash
docker run -d --name sqlagent docker.xuanyuan.run/dbhi/sql-agent

然后运行本服务，挂载 queries.yml 文件并链接SQL Agent服务：

shell
docker run -d \
  --name prometheus-sql \
  -p 8080:8080 \
  -v ${PWD}/queries.yml:/queries.yml \
  --link sqlagent:sqlagent \
  docker.xuanyuan.run/dbhi/prometheus-sql

如果需要分离数据库连接信息等，可在单独文件中指定数据源并挂载：

shell
docker run -d \
  --name prometheus-sql \
  -p 8080:8080 \
  -v ${PWD}/queries.yml:/queries.yml \
  -v ${PWD}/prometheus-sql.yml:/prometheus-sql.yml \
  --link sqlagent:sqlagent \
  docker.xuanyuan.run/dbhi/prometheus-sql \
  -service http://sqlagent:5000 \
  -config prometheus-sql.yml

要查看指标的纯文本版本，可在浏览器中打开 http://localhost:8080/metrics（boot2docker用户使用 <[***]>）。

Docker Compose运行

也可使用仓库中包含的 docker-compose.yml 文件。需在 volumes 部分添加挂载 queries.yml 文件的配置。

贡献指南

开始前请阅读贡献说明。

常见问题

如何为数据库连接提供额外选项？

额外选项在 config.yml 文件中设置，具体为https://github.com/chop-dbhi/prometheus-sql/blob/master/examples/example-queries.yml#L14-L19中的键值对。这些选项会传递给https://github.com/chop-dbhi/sql-agent#connection-options，后者构建DSN字符串以在后端建立连接（也可直接设置 dsn 键为完整字符串）。

例如，在开发环境中使用Postgres时，常见问题是忽略服务器未启用SSL，可通过在连接映射中添加 sslmode: disable 来解决：

yaml
    # ...
    connection:
        host: example.org
        port: 5432
        user: postgres
        password: s3cre7
        database: products
        sslmode: disable