prom/promdash

注意：PromDash 已被弃用。目前官方推荐使用 Grafana 来可视化 Prometheus 指标，因为它原生支持 Prometheus，且被广泛采用、功能强大。

PromDash

Prometheus 的仪表板工具，用于展示和可视化监控指标。

!promdash

测试

![构建状态]([***]

Ruby

bash
$ bundle exec rake

JavaScript

bash
$ RAILS_ENV=test bundle exec rake karma:run

JSHint

所有拉取请求都会运行 JSHint。为缩短反馈周期，建议在本地运行 JSHint。安装 NPM 后，安装并运行 JSHint：

bash
$ npm install jshint -g
$ jshint app/assets/javascripts

部署

开发模式

完整的开发周期需要安装多个依赖。以下以 Ubuntu 14.04 LTS 为例，若 bundle 命令出错，最可能原因是数据库服务器未正确安装开发头文件/库。

• Node.js
  • sudo apt-get install nodejs nodejs-legacy npm
• Ruby
  • sudo apt-get install ruby-full（详情）
• MySQL
  • sudo apt-get install libmysqlclient-dev（详情）
• PostgreSQL
  • sudo apt-get install postgresql-9.{3|4} postgresql-server-dev-9.{3|4}（详情）
• SQLite
  • sudo apt-get install sqlite3 libsqlite3-dev（详情）

安装 gems：

bash
bundle

设置数据库：

bash
cp config/database.yml.example config/database.yml
RAILS_ENV=development bundle exec rake db:setup

启动 Rails 服务器：

bash
bundle exec rails s

生产模式

在生产模式下，需要定义多个环境变量来配置数据库参数：

bash
DATABASE_URL="mysql2://username:password@host/database"
RAILS_ENV="production"

注意：除 MySQL 外，还可使用其他与 Rails 兼容的关系型数据库，如 PostgreSQL 或 SQLite3。详见 [***]

创建独立的 Ruby 环境并预编译资源：

bash
make build

从捆绑环境运行生产服务器：

bash
bin/env bin/bundle exec bin/thin -p $PORT start

使用 Docker 部署

要使用 Docker 部署 PromDash，可使用 https://registry.hub.docker.com/u/prom/promdash/ Docker 镜像。默认情况下，该镜像会以生产模式启动 thin webserver。若要运行迁移等 rake 任务，可指定任何命令作为 Docker 镜像的参数。

Docker 快速启动部署

以下是使用基于文件的本地数据库运行 PromDash 的快速启动示例。

首先，在主机上的共享本地 Docker 卷中创建 SQLite3 数据库：

bash
docker run --rm -v /tmp/prom:/tmp/prom \
       -e DATABASE_URL=sqlite3:/tmp/prom/file.sqlite3 \
       prom/promdash ./bin/rake db:migrate

然后，使用刚创建的数据库启动 PromDash：

bash
docker run -p 3000:3000 -v /tmp/prom:/tmp/prom \
       -e DATABASE_URL=sqlite3:/tmp/prom/file.sqlite3 \
       prom/promdash

可直接向 thin 服务器传递参数：

bash
docker run -p 3000:4000 -v /tmp/prom:/tmp/prom \
       -e DATABASE_URL=sqlite3:/tmp/prom/file.sqlite3 \
       prom/promdash ./bin/thin -a localhost -p 4000 start

在反向代理后部署

要在反向代理后部署 PromDash，可使用环境变量 PROMDASH_PATH_PREFIX 和 RAILS_RELATIVE_URL_ROOT 设置全局路径前缀。设置后，所有 URL 都将以指定前缀开头。

一种简单的方式是在同一台机器上运行反向代理、Prometheus 和 PromDash，通过认证保护部署，限制直接的 IP:PORT 访问。

反向代理（如 nginx、HAProxy）

• 设置单个域名。
• 将 http(s)://dash.example.com/dash 路由到后端 localhost:3000
• 将 http(s)://dash.example.com/prom 路由到后端 localhost:9090
• 为两个后端配置相同的访问控制列表（ACL），如 HTTP 基本认证。

运行 Prometheus 时仅绑定到 localhost，以限制绕过认证的直接外部网络访问。记得在 -web.external-url 中传递路径部分。Docker 示例：(完整参考)

bash
docker run -p 127.0.0.1:9090:9090 -v /prometheus-data \
       prom/prometheus -config.file=/prometheus-data/prometheus.yml \
                       -web.external-url "http://dash.example.com/prom"

运行 PromDash 的方式类似。运行后，在 Web UI（http://dash.example.com/dash）中添加 URL 为 http://dash.example.com/prom/ 的 Prometheus 服务器。

bash
docker run -p 127.0.0.1:3000:3000 -v /tmp/prom:/tmp/prom \
       -e DATABASE_URL=sqlite3:/tmp/prom/file.sqlite3 \
       -e PROMDASH_PATH_PREFIX=/dash \
       -e RAILS_RELATIVE_URL_ROOT=/dash \
       prom/promdash

最后，访问 dash.example.com/dash 和 dash.example.com/prom 检查反向代理是否正常工作，两者都应提示输入凭据（如 HTTP 基本认证）。可使用 Chrome 无痕模式强制重新认证。然后访问公共 IP 的 <IP>:3000/dash 和 <IP>:9090/prom，确认无法直接访问（页面加载错误）。

部署清单

部署 PromDash 新版本前，请遵循以下清单：

• 研究自上次部署以来的变更：
  • 是否需要执行迁移（bundle exec rake db:migrate）？
  • 是否需要设置新的环境变量？
  • 存储的仪表板 JSON 格式是否有不兼容的变更？
• 为安全起见，创建当前 PromDash 数据库的备份。
• 新版本的测试是否通过？
• 是否有其他高风险变更？

部署新版本后：

• 在浏览器中执行硬刷新，确保所有加载的资源都是最新的。
• 测试基本功能（如 Prometheus 和 Graphite 图表设置等）。

安全考虑

由于经常需要在内联框架（iframe）中显示各种 PromDash 视图，我们为所有视图禁用了 Rails 的默认头 X-Frame-Options: SAMEORIGIN：

https://github.com/prometheus/promdash/commit/5b1da215296b5316568ad7c8449652f0d7f74ebe

如果担心 点击劫持***，只要不需要在 iframe 中显示仪表板，恢复此提交是安全的。