prom/promlens

PromLens

镜像概述

PromLens是一款基于Web的PromQL查询构建器、分析器和可视化工具，最初由PromLabs开发为商业软件，后由PromLabs和Chronosphere***给Prometheus开源项目。该工具旨在简化PromQL查询的创建、解析和结果可视化过程，适用于Prometheus监控系统的用户日常查询开发与调试工作。

核心功能与特性

• PromQL查询构建：提供直观的可视化界面，辅助用户快速构建PromQL查询语句
• 查询分析：将PromQL查询解析为树形结构视图，帮助理解查询逻辑与结构
• 结果可视化：支持多种可视化方式展示查询结果，便于指标趋势分析
• 链接共享：支持持久化查询页面状态并生成共享链接，便于团队协作
• Grafana集成：可连接Grafana实例，直接选择Grafana中的数据源进行查询

使用场景与适用范围

• Prometheus用户：日常构建、调试和优化PromQL查询
• 监控管理员：分析监控指标，生成可视化报告
• 团队协作：共享查询配置、结果和分析视角
• 教学培训：演示PromQL查询逻辑与最佳实践

安装与使用方法

Docker镜像获取

PromLens Docker镜像可从以下仓库获取：

• Docker Hub：prom/promlens
• Quay：quay.io/prometheus/promlens

基本运行示例

最小化部署命令，启动PromLens并映射默认端口：

bash
docker run -p 8080:8080 prom/promlens

启动后可通过 http://localhost:8080 访问Web界面。

高级配置示例

启用链接共享（SQLite后端）

使用SQLite数据库存储共享链接，需挂载本地目录持久化数据：

bash
docker run -p 8080:8080 -v /path/to/local/db:/data prom/promlens \
  --shared-links.sql.driver=sqlite \
  --shared-links.sql.dsn=/data/promlens-links.db

启用Grafana集成

连接Grafana实例以获取数据源，需提供Grafana URL和API令牌：

bash
docker run -p 8080:8080 prom/promlens \
  --grafana.url=https://your-grafana-instance:3000 \
  --grafana.api-token=your-grafana-api-token

命令行参数说明

查看所有可用参数：

bash
docker run prom/promlens --help

布尔参数说明：默认值为true的布尔参数可通过--no-<flag-name>禁用，例如--no-shared-links.sql.create-tables禁用自动创建数据库表。

配置详解

链接共享配置

链接共享默认禁用，支持以下后端存储方式：

SQLite

bash
docker run -p 8080:8080 -v /local/db:/db prom/promlens \
  --shared-links.sql.driver=sqlite \
  --shared-links.sql.dsn=/db/promlens.db

MySQL

bash
docker run -p 8080:8080 prom/promlens \
  --shared-links.sql.driver=mysql \
  --shared-links.sql.dsn="user:password@tcp(mysql-host:3306)/promlens?parseTime=true"

需手动创建数据库表时，执行https://github.com/prometheus/promlens#mysql

Postgres

bash
docker run -p 8080:8080 prom/promlens \
  --shared-links.sql.driver=postgres \
  --shared-links.sql.dsn="host=postgres-host port=5432 user=user password=password dbname=promlens sslmode=disable"

Google Cloud Storage (GCS)

bash
docker run -p 8080:8080 -e GOOGLE_APPLICATION_CREDENTIALS=/credentials.json \
  -v /path/to/credentials.json:/credentials.json prom/promlens \
  --shared-links.gcs.bucket=your-gcs-bucket-name

Grafana集成配置

配置参数

• --grafana.url：Grafana实例URL（必填）
• --grafana.api-token：Grafana API令牌（直接提供）
• --grafana.api-token-file：Grafana API令牌文件路径（从文件读取）

创建Grafana API令牌

1. 登录Grafana，进入Configuration > API Keys
2. 点击Add API key，设置名称、角色（需"Admin"权限）和有效期
3. 保存生成的API令牌并在启动时配置

URL参数使用

• 预选择数据源：通过ds参数指定Grafana数据源ID，如http://localhost:8080/?ds=1
• 直接加载查询：通过q参数指定PromQL查询，如http://localhost:8080/?q=up

架构说明

基础架构（无高级功能）

仅用于提供静态资源和解析PromQL查询，架构如下：

• 后端：提供静态资源服务和PromQL解析
• 前端：Web界面，处理用户交互和查询可视化

高级架构（启用链接共享/Grafana集成）

后端额外承担以下职责：

• 存储和检索共享链接数据
• 连接Grafana API获取数据源列表
• 代理Grafana数据源查询请求