promlabs/promlens

PromLens

本仓库包含PromLens PromQL查询构建器、分析器和可视化工具的文档、公开问题和功能请求。

报告问题

请在https://github.com/promlabs/promlens-public/issues%E6%8F%90%E4%BA%A4%E5%85%AC%E5%BC%80%E9%97%AE%E9%A2%98%E3%80%82

自行运行PromLens

以下文档说明如何使用https://hub.docker.com/%E8%87%AA%E8%A1%8C%E8%BF%90%E8%A1%8CPromLens%E3%80%82

注意：PROMLENS仍处于实验性预览版本，按"原样"提供。

部署示例

无许可证密钥运行PromLens，禁用链接共享和Grafana集成：

docker run -p 8080:8080 promlabs/promlens

使用许可证密钥运行PromLens，启用链接共享和Grafana集成，使用SQLite存储链接共享数据：

docker run -p 8080:8080 promlabs/promlens \
  --license.key=$LICENSE_KEY \
  --shared-links.sql.driver=sqlite3 \
  --shared-links.sql.dsn=/tmp/promlens-links.db \
  --grafana.url=$GRAFANA_URL \
  --grafana.api-token=$GRAFANA_API_TOKEN

然后访问http://localhost:8080/查看PromLens Web UI。

标志

Docker镜像中的promlens二进制文件具有以下标志：

./promlens --help
usage: promlens [<flags>]

The PromLens server

Flags:
  -h, --help                     显示上下文相关帮助（也可尝试--help-long和--help-man）。
      --license.key=""           PromLens许可证密钥（设置此参数或--license.key-file）。
      --license.key-file=""      包含PromLens许可证密钥的文件路径（设置此参数或--license.key）。
      --shared-links.gcs.bucket=""
                                 用于存储共享链接的GCS存储桶名称。设置GOOGLE_APPLICATION_CREDENTIALS环境变量指向定义服务账户凭据的JSON文件（需要具有在提供的存储桶中创建、删除和查看对象的权限）。
      --shared-links.sql.driver=""
                                 用于在SQL数据库中存储共享链接的SQL驱动程序。支持的值：[mysql, sqlite3]。
      --shared-links.sql.dsn=""  使用SQL数据库存储共享链接时的SQL数据源名称（MySQL参见https://github.com/go-sql-driver/mysql#dsn-data-source-name，SQLite3参见https://github.com/mattn/go-sqlite3#dsn-examples）。或者，使用环境变量PROMLENS_SHARED_LINKS_DSN指定此值。
      --shared-links.sql.create-tables
                                 使用SQL数据库存储共享链接时是否自动创建所需表。
      --grafana.url=""           Grafana安装的URL，用于启用Grafana数据源选择器。
      --grafana.api-token=""     传递给Grafana API的身份验证令牌。
      --grafana.api-token-file=""
                                 包含传递给Grafana API的身份验证令牌的文件。
      --web.listen-address=":8080"
                                 Web API监听地址。
      --web.external-url=""      PromLens可外部访问的URL（例如，若通过反向代理提供PromLens服务）。用于生成返回PromLens本身的相对和绝对链接。如果URL包含路径部分，将用于前缀PromLens提供的所有HTTP端点。若省略，相关URL组件将自动推导。
      --web.route-prefix=""      Web端点内部路由的前缀。默认为--web.external-url的路径。
      --web.default-prometheus-url=""
                                 加载PromLens时使用的默认Prometheus URL。
      --log.level=info           仅记录具有指定严重性或更高级别的消息。可选值：[debug, info, warn, error]
      --log.format=logfmt        日志消息的输出格式。可选值：[logfmt, json]

提供许可证密钥（可选，用于非免费功能）

要启用PromLens的非免费功能（如Grafana数据源选择器和链接共享），需要提供许可证密钥。如需要试用许可证密钥，请发送邮件至***。

直接通过标志值提供许可证密钥启动PromLens：

docker run -p 8080:8080 promlabs/promlens --license.key=$LICENSE_KEY

或者，通过文件提供许可证密钥：

docker run -p 8080:8080 promlabs/promlens --license.key-file=$LICENSE_KEY_FILE

启用链接共享

注意：链接共享需要有效的PromLens许可证密钥。

默认情况下，链接共享后端处于禁用状态。可通过Google Cloud Storage、MySQL或SQLite3启用链接共享：

Google Cloud Storage

要使用Google Cloud Storage (GCS)存储共享链接，设置--shared-links.gcs.bucket=<bucket name>标志，并设置GOOGLE_APPLICATION_CREDENTIALS环境变量指向包含服务账户凭据的JSON文件（需要具有在提供的存储桶中创建、删除和查看对象的权限）。

SQlite3

要将共享链接保存到本地SQLite3数据库，设置--shared-links.sql.driver=sqlite3和--shared-links.sql.dsn=<database filename>标志。

MySQL

要将共享链接保存到MySQL数据库，设置--shared-links.sql.driver=mysql和--shared-links.sql.dsn=<data source name>标志（MySQL DSN规范参见https://github.com/go-sql-driver/mysql#dsn-data-source-name%EF%BC%89%E3%80%82

默认情况下，PromLens会尝试在MySQL数据库中自动创建必要的表。这要求PromLens数据库用户具有CREATE权限。要关闭MySQL的自动表创建，设置--no-shared-links.sql.create-tables=false标志。若要手动创建表，请对PromLens MySQL数据库运行以下SQL：

sql
CREATE TABLE IF NOT EXISTS link (
  id INT AUTO_INCREMENT PRIMARY KEY,
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  short_name VARCHAR(11) UNIQUE,
  page_state TEXT
);

CREATE TABLE IF NOT EXISTS view(
  id INT AUTO_INCREMENT PRIMARY KEY,
  link_id INTEGER,
  viewed_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  FOREIGN KEY(link_id) REFERENCES link(id)
);

启用Grafana数据源集成

注意：Grafana数据源集成需要有效的PromLens许可证密钥。

要启用从现有Grafana安装中选择数据源，设置--grafana.url标志为Grafana安装的URL，并设置--grafana.api-token标志（直接提供API令牌）或--grafana.api-token-file标志（从文件提供API令牌）。

创建Grafana API令牌

要创建适合在Grafana中查找数据源的API令牌：

• 在Grafana中前往"Configuration > API Keys"。
• 点击"Add API key"。
• 为密钥指定描述性名称，将"Role"设置为"Admin"，并设置所需的有效期（建议较长，否则需要频繁重新生成）。
• 按"Add"并记录显示的API令牌。

架构

根据是否使用许可证启用商业功能，PromLens后端的职责有所不同：

基本功能

运行具有基本功能的PromLens（无Grafana集成或链接共享）时，后端仅用于提供静态资产和将PromQL查询解析为树视图：

!基本PromLens架构

商业功能（带许可证）

如果启用链接共享和/或Grafana数据源集成，后端还会存储和检索共享链接，并连接到Grafana以列出数据源和代理查询：

!高级PromLens架构

许可证

详见Docker镜像中包含的LICENSE文件以获取详细条款和条件。

如需要试用许可证密钥以解锁商业功能，请发送邮件至***。