mbenabda/promtool

promtool-container-image 文档

镜像概述

promtool-container-image 是一个包含 Prometheus promtool CLI 工具的 Docker 镜像，源码托管于 https://github.com/mbenabda/promtool-container-image%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%97%A8%E5%9C%A8%E6%8F%90%E4%BE%9B%E8%BD%BB%E9%87%8F%E7%BA%A7%E7%9A%84 promtool 运行环境，方便在 CI（持续集成）流水线中集成 Prometheus 相关的验证和检查任务。

核心功能与特性

• 内置 promtool 工具：镜像中包含完整的 Prometheus promtool 二进制可执行文件，支持所有 promtool 原生功能（如规则验证、配置检查、单元测试等）。
• 版本标签对应：镜像标签严格匹配 Prometheus 官方发布版本（如镜像标签 v2.45.0 对应 Prometheus v2.45.0 版本的 promtool），确保工具版本与 Prometheus 环境兼容。
• 轻量级设计：优化镜像体积，适合在资源受限的 CI 环境中快速拉取和运行。
• CI 友好：无需在 CI 环境中手动安装 promtool，直接通过容器化方式调用，简化环境配置。

使用场景

该镜像主要适用于以下场景：

• CI 流水线中的规则验证：在 Prometheus 告警规则或记录规则提交前，通过 promtool check rules 验证规则语法和逻辑性。
• 配置文件检查：使用 promtool check config 验证 Prometheus 配置文件的有效性。
• 单元测试执行：通过 promtool test rules 运行规则单元测试，确保规则行为符合预期。
• 自动化部署前置检查：在 Prometheus 配置或规则部署前，作为自动化流程的一部分执行必要验证，减少部署风险。

使用方法与配置说明

镜像拉取

镜像可从 Docker Hub 拉取（假设镜像已发布至 Docker Hub，具体请参考源仓库说明），命令格式如下：

bash
docker pull mbenabda/promtool:<prometheus-version>

其中 <prometheus-version> 需替换为目标 Prometheus 版本号，例如拉取对应 Prometheus v2.45.0 的镜像：

bash
docker pull mbenabda/promtool:v2.45.0

基本使用示例

验证 Prometheus 规则文件

在 CI 环境中，将本地规则文件挂载到容器内，使用 promtool check rules 验证规则：

bash
# 假设当前目录下有待验证的规则文件 rules.yml
docker run --rm -v $(pwd):/workspace mbenabda/promtool:v2.45.0 check rules /workspace/rules.yml

验证 Prometheus 配置文件

验证 Prometheus 配置文件（如 prometheus.yml）的有效性：

bash
# 假设当前目录下有待验证的配置文件 prometheus.yml
docker run --rm -v $(pwd):/workspace mbenabda/promtool:v2.45.0 check config /workspace/prometheus.yml

运行规则单元测试

执行规则单元测试（测试文件通常以 _test.yml 结尾）：

bash
# 假设当前目录下有测试文件 rules_test.yml
docker run --rm -v $(pwd):/workspace mbenabda/promtool:v2.45.0 test rules /workspace/rules_test.yml

CI 流水线集成示例（GitLab CI/CD）

在 .gitlab-ci.yml 中集成规则验证步骤：

yaml
stages:
  - validate

validate-prometheus-rules:
  stage: validate
  image: mbenabda/promtool:v2.45.0
  script:
    - promtool check rules ./rules/*.yml
  only:
    - merge_requests
    - main

注意事项

• 确保挂载的文件路径在容器内可访问（如通过 -v 参数挂载主机目录到容器内工作目录）。
• 镜像标签需与目标 Prometheus 环境版本保持一致，避免因版本差异导致验证结果不准确。
• 更多 promtool 命令用法可通过 docker run --rm mbenabda/promtool:v2.45.0 --help 查看。

版本对应关系

镜像标签与 Prometheus 版本严格一一对应，例如：

• 镜像标签 v2.45.0 → 包含 Prometheus v2.45.0 版本的 promtool
• 镜像标签 v2.44.0 → 包含 Prometheus v2.44.0 版本的 promtool

具体版本列表可参考 https://github.com/mbenabda/promtool-container-image/releases%E3%80%82