查看文档目录

状态页

状态页:给你的客户一个公开的服务状态页,展示各组件当前状态、可用率、事件与维护公告;另有平台状态 JSON 供官网引用。

作用

状态页是一个公开的网页,访客不用登录就能看到你的服务现在是否正常、过去的可用率,以及你发布的事件和维护公告。页面不显示节点 IP、主机名或节点数量。

使用场景

  • 线路出现波动时,向客户说明影响范围和进展。
  • 提前公告维护窗口。
  • 用线路组的可用节点比例自动反映某条线路的健康状况。

在哪里配置

控制台:系统,状态页。分两个页签:“页面与组件”和“事件与维护”。页面的公开地址显示在页面顶部,可以直接打开或复制,路径是 /status/。

配置项

页面与组件

配置项说明
公开状态页开关;未开启时访客看到“状态页未开启”
页面标题留空则用“服务状态”
页面说明显示在标题下方
显示品牌 logo开关
组件最多 50 个,可排序;名称 1 到 64 个字,名称不能重复

组件的属性:

属性说明
名称、说明展示给访客
状态来源“手动”,或“线路组”
线路组来源为线路组时选择,状态由该线路组可用节点的比例自动计算
手动状态正常、降级、中断、维护中

组件当前状态取自动状态、手动状态、未恢复事件的影响和生效中的维护窗口里最严重的一项。删除组件会同时删除它的历史可用率。

事件与维护

类型状态流转
事件调查中,已定位,监控中,已恢复
维护已计划,进行中,已完成

发布事件需要填写标题、影响(降级或中断)、受影响组件和进展说明;安排维护还要填写维护起止时间。之后可以“更新进展”,每次更新都会显示给访客。已结束的事件不能再更新,误发的可以删除。公开页显示近 14 天的事件与维护。

平台状态

授权端运营后台的“平台状态”页维护平台自己的组件(最多 20 个,可增删排序)、事件与维护,并通过公开 JSON 提供给官网等页面引用:

GET /public/v1/platform-status

常见问题

访客打开 /status/ 看到“状态页未开启”

在“页面与组件”里打开“公开状态页”开关。

自动状态显示的是什么

线路组里启用的端点中,健康的占比。端点健康,或没有探测数据但所属节点在线且处于启用状态,都算可用。

能不能只手动维护

可以。把状态来源设为“手动”,自己改状态。

需要什么权限

查看需要系统配置读取权限,修改需要系统配置管理权限。