sergiitk/pagerbeauty

Pager Beauty

为监控仪表板添加简洁的PagerDuty值班状态小部件。在线演示

功能预览

谁在值班？

!PagerDuty值班状态

核心功能和特性

• 显示PagerDuty值班人员信息
• 实时监控活动事件状态
• 支持多种部署方式（Docker、Heroku、AWS、Node.js）
• 可配置刷新频率
• 支持HTTP基本认证和访问令牌认证
• 兼容Datadog和Grafana仪表板集成
• 响应式HTML布局
• 支持自定义时区

使用场景和适用范围

• 运维团队监控仪表板
• DevOps工作流可视化
• 团队值班状态展示
• 事件响应中心状态监控

部署方法

Heroku部署

最简单的方法是使用Heroku按钮一键部署。如需使用Heroku CLI手动部署或保持更新，请参考https://github.com/sergiitk/pagerbeauty/tree/master/docs/heroku.md%E3%80%82

AWS部署

PagerBeauty提供https://raw.githubusercontent.com/sergiitk/pagerbeauty/master/.aws/pagerbeauty.cloudformation%E3%80%82%E8%AF%A6%E7%BB%86%E9%83%A8%E7%BD%B2%E6%AD%A5%E9%AA%A4%E8%AF%B7%E5%8F%82%E8%80%83https://github.com/sergiitk/pagerbeauty/tree/master/docs/aws.md%E3%80%82

Docker部署

Docker仓库: https://hub.docker.com/r/sergiitk/pagerbeauty

可使用Docker在本地或基础设施上运行PagerBeauty（访问http://localhost:8080）。

使用.env文件运行:

sh
# 首先创建.env配置文件（详见配置部分）
docker run --rm -p 8080:8080 --env-file=.env -it sergiitk/pagerbeauty:latest

直接设置环境变量运行:

sh
docker run --rm -p 8080:8080 -e PAGERBEAUTY_PD_API_KEY=yourkey -e PAGERBEAUTY_PD_SCHEDULES=SCHEDL1,SCHEDL2 -it sergiitk/pagerbeauty:latest

测试示例:

sh
docker run --rm -p 8080:8080 -e PAGERBEAUTY_PD_API_KEY=y_NbAkKc66ryYTWUXYEu -e PAGERBEAUTY_PD_SCHEDULES=PJ1P5JQ,P538IZH -it sergiitk/pagerbeauty:latest

Node.js部署

NPM仓库: pagerbeauty

sh
# 安装依赖
yarn add pagerbeauty
# 运行应用
node -r esm node_modules/pagerbeauty/src/pagerbeauty.js

配置说明

通过.env文件或环境变量配置PagerBeauty：

sh
# 注意：为保证Docker兼容性，值周围不要添加引号
# 参考：https://docs.docker.com/compose/env-file/

# PagerDuty REST API v2访问密钥（只读）
# 文档：https://support.pagerduty.com/docs/using-the-api
PAGERBEAUTY_PD_API_KEY=yourkey

# 逗号分隔的PagerDuty调度ID列表
# 调度ID可在PagerDuty网站调度页面URL的#符号后找到
# 例如：调度URL https://example.pagerduty.com/schedules#PJ1P5JQ 的ID为PJ1P5JQ
PAGERBEAUTY_PD_SCHEDULES=SCHEDL1,SCHEDL2

# （可选）调度刷新频率（分钟）
# 默认值：10
# PAGERBEAUTY_REFRESH_RATE_MINUTES=10

# （可选）禁用活动事件轮询
# 默认值：false
# PAGERBEAUTY_INCIDENTS_DISABLE=true

# （可选）活动事件刷新频率（分钟）
# 默认值：1
# PAGERBEAUTY_INCIDENTS_REFRESH_RATE_MINUTES=5

# （可选）加载调度时获取用户联系电话
# 默认值：false
# PAGERBEAUTY_LOAD_USER_CONTACT_METHODS=true

# （可选）应用日志的最高级别
# 可选值：error, warn, info, verbose, debug, silly
# 默认值：info
# PAGERBEAUTY_LOG_LEVEL=verbose

# （可选）日志格式
# 可选值：
# machine - 机器可读的JSON格式
# human   - 人类可读的彩色格式
# 默认值：开发环境为`human`，生产环境为`machine`
# PAGERBEAUTY_LOG_FORMAT=machine

# （可选）HTTP服务器监听端口
# 默认值：8080
# PAGERBEAUTY_HTTP_PORT=80

# （可选）启用HTTP基本认证
# 默认值：禁用
# PAGERBEAUTY_HTTP_USER=basic_username
# PAGERBEAUTY_HTTP_PASSWORD=basic_password

# （可选）启用访问令牌认证（RFC6750）
# 注意：大多数现代浏览器不支持嵌入包含基本HTTP认证的iframe
# 可通过设置随机访问令牌并附加到调度URL来解决，例如：
# https://pb.example.com/v1/schedules/P538IZH.html?access_token=your_token
# 建议使用HTTPS
# 默认值：禁用
# PAGERBEAUTY_HTTP_ACCESS_TOKEN=your_token

集成到Datadog仪表板

1. 在PagerBeauty中打开调度列表（确保应用通过HTTPS运行）
2. 找到要嵌入的调度，复制其URL
3. 打开Datadog仪表板，点击"编辑面板"
4. 将"IFrame"小部件拖到面板上
5. 在Datadog面板的"IFrame URL"中粘贴复制的PagerBeauty调度URL
6. 调整大小并保存！

集成到Grafana仪表板

1. 安装AJAX插件：

   sh
   grafana-cli plugins install ryantxu-ajax-panel
   

2. 重启Grafana服务器
3. 在PagerBeauty中打开调度列表
4. 找到要嵌入的调度，打开并复制其URL
5. 打开Grafana仪表板，点击"添加面板"
6. 选择"AJAX"面板
7. 点击"面板标题" -> "编辑"
8. 在"请求"选项卡中填写：
   • URL：粘贴复制的PagerBeauty调度URL
   • 方法：iframe
   • 参数：{ theme: "grafana" }
9. 在"常规"选项卡中，设置面板标题并勾选"透明"
10. 关闭面板编辑，调整大小并保存！

常见问题（FAQ）

工作原理

PagerBeauty作为PagerDuty调度的本地缓存服务器，使用PagerDuty API密钥在后台获取和刷新调度信息，并通过Web界面提供访问。这样可以保护API密钥不被公开暴露，因此需要将PagerBeauty作为服务运行。

如何添加用户头像？

PagerDuty使用Gravatar管理个人资料照片。如果已有Gravatar账户，可将PagerDuty登录***关联到该账户。

如何设置自定义时区？

默认情况下，"从"和"到"字段以调度的时区显示。可通过在调度URL后添加?timezone=value来覆盖，支持任何https://github.com/moment/luxon/blob/master/docs/zones.md#specifying-a-zone%E3%80%82%E4%BE%8B%E5%A6%82%EF%BC%9A

• 客户端浏览器本地时区：?timezone=local
• UTC：?timezone=UTC
• UTC偏移：?timezone=UTC+5
• IANA时区：?timezone=Europe/Kiev