设置公共状态页
每个实体都可以为没有账户的人员发布一个状态页:客户的客户、分支机构的员工、合作伙伴。它回答一个问题:我使用的服务是否正常运行?,并使用该实体自己的名称、徽标和颜色。本指南介绍如何创建页面、构建其组件、发布事件以及发布页面。
开始之前
- 你需要在页面所代表的实体上具有 Entity admin 角色。
- 必须启用功能开关
ui.public_status_page。在它关闭期间,页面无法打开,屏幕上会说明这一点;超级管理员在 Settings › Instance 中切换它。 - 确定访问者应认出什么:诸如 客户门户 或 银行卡支付 的服务,而不是服务器名称。
访问者能看到什么,绝不会看到什么
该页面是根据允许列表逐字段构建的,而不是通过过滤内部数据生成的。
| 页面上显示 | 页面上绝不显示 |
|---|---|
| 标题、简介、徽标、主题和强调色 | 资源名称、主机名、类型、标记或 ID |
| 组件,使用你给它们起的名称,分组并按你的顺序排列 | 检查、指标、值或阈值 |
| 每个组件的状态及其 90 天可用性条 | 警报、其标题、严重性或数量 |
| 你发布的事件,包括每次更新及其时间 | 发布者、负责人,以及警报收件箱中的任何内容 |
| 你选择发布的维护,包括其公开标题和描述 | 维护时段的内部原因 |
| 指向 RSS、Atom 和 JSON Feed 的链接,以及一个不显眼的 Sign in 链接 | 实体路径、其他实体,或产品的名称和徽标 |
创建页面
-
打开 Settings › Status page,在选取器中选择实体,例如高密物流。
-
选择 Create a status page for 高密物流。页面创建后处于未发布状态。
-
在 Page 下,填写设置:
设置 说明 Title 同时用作浏览器选项卡和订阅源的名称 Introduction 标题下方的一段简短文字 Logo address https://…,或此服务器上的路径,例如/logos/ciguapa.svg。为空时,如果分支有徽标,则使用分支的徽标;绝不使用产品的徽标Theme 任一控制台主题;默认为 Daylight Accent colour 用于链接和焦点环的颜色,或 Use the theme's Time zone of the daily bars 可用性条中每一天的起止位置。事件和维护的时间按每位访问者自己的时区显示 Own domain 可选,例如 status.ciguapa.example;见下文 -
选择 Save。
Public address 为 https://<server>/status/<entity short name>。Open the public page 会打开它;Show preview 会在此处显示它,无论是否已发布。
添加组件
组件是访问者能够识别的内容。它跟踪(follow)页面所属实体或其下级实体的资源:整个资源,或者当只有某项检查对服务重要时,资源的单个检查。
- 在 Components 下,选择 Add a component。
- 输入 Name,例如 银行卡支付,还可以输入 Description 和 Group。具有相同分组的组件会显示在一起。
- 在 Follows 下,选择一个 Resource,以及 The whole resource 或某个 Check,然后选择 Follow。对服务所依赖的每个资源重复此操作。
- 保持选中 Show the 90-day availability bar,除非百分比对此组件意义不大。
- 将 Status shown 保持为 From what it follows。
- 选择 Save component。
使用箭头更改顺序。屏幕会在每个组件旁边显示它所跟踪的资源的状态,因此很容易发现过时的手动状态。
| 它所跟踪的资源的状态 | 组件状态 |
|---|---|
| 所有被跟踪的资源都正常;处于信息级别的检查也算正常 | Operational |
| 一个处于警告级别 | Degraded performance |
| 部分资源为严重级别或无法访问 | Partial outage |
| 所有报告数据的资源都为严重级别 | Major outage |
| 所有资源都处于维护时段 | Under maintenance |
| 尚无任何报告 | 页面上为 Operational,条中为 No data |
处于维护中的资源既不加分也不减分:一个数据库节点处于维护中、另一个正常,则为 Operational。已静默的资源按其检查的真实状态计算,因为静默改变的是通知,而不是服务。
若要手动覆盖状态,例如在你比检查了解更多情况时设为 Major outage,请在 Status shown 中选择它。之后请将其改回 From what it follows。
发布页面
- 使用 Show preview 检查页面。
- 在 Page 下,选择 Published,然后选择 Save。
页面未发布时,其地址会返回 not found;预览仍可使用。
报告事件
- 在 Incidents 下,选择 Report an incident。
- 输入 Title、Impact(No impact、Minor impact、Major impact 或 Critical impact)、Affected components、Status 和第一条 Message。
- 选择 Report。事件及其第一条更新会连同时间一起显示在页面和订阅源中。
- 随着你了解到更多情况,使用 Post update 发布更新,每次更新都带有状态(Investigating、Identified、Monitoring 或 Resolved)和一条消息。
未结束的事件会将其影响的组件状态至少提升到其影响级别:次要影响对应 Degraded performance,重大影响对应 Partial outage,严重影响对应 Major outage。发布 Resolved 会关闭它;它会在 Past incidents 下保留 30 天。
通过 API,你还可以更正早期更新的文本(但不能更正其时间或状态),并可在事后报告事件,同时指定其开始时间。
发布维护公告
创建维护时段时,请选择 Announce on the status page,并填写 Public title,还可以填写 Public description;参阅规划维护时段。该时段会显示在每个其组件跟踪了它所涵盖资源的实体的页面上:进行期间显示在 Maintenance 下,否则显示其 30 天内的下一次发生。每周时段会说明它会重复,而不是逐周列出。只显示公开标题和描述,绝不显示内部原因。
在自有域名上提供页面
若要将页面发布为 https://status.ciguapa.example/status/ciguapa:
- 将该名称的 DNS 指向服务器,使用
CNAME或A记录。 - 请超级管理员在 Settings › Server and certificates 中将该名称添加为别名,并在使用 Let's Encrypt 证书或自有证书时,让该名称包含在证书的名称之中。参阅设置名称和 TLS。
- 在页面的 Own domain 中输入该名称,然后选择 Save。
当通过该名称打开页面时,页面及其订阅源中的链接就会使用该名称。该名称的根地址 https://status.ciguapa.example/ 仍会打开控制台的登录页面,因此请分享带有 /status/<short name> 的完整地址。
设置分支外观
Settings › Branch appearance 可为实体设置 Default theme 和 Logo address;其下的每个实体都会继承它们,直到设置自己的值。In effect 显示结果及其来源。没有自己徽标的状态页会使用其实体的徽标。在此版本中,控制台本身尚未应用分支的主题;无论如何,个人自己选择的主题都会优先于它。
可用性
每个组件都会按页面时区的每一天,记录它在每种状态下停留的时间。发生夏令时变更的日子有 23 或 25 个小时。条中每天显示一个单元格,计算机上为 90 个,平板电脑上为 60 个,手机上为 30 个,颜色取决于当天持续一分钟或更长时间的最差状态,悬停、点按或键盘聚焦时会显示详细信息。
- 每日正常运行率 = 1 − (Major outage 时间 + 0.3 × Partial outage 时间) ÷ 已知时间。Degraded performance 计为正常运行。维护和 No data 不计入已知时间,因此计划内的工作绝不会降低该数字。
- 标题百分比在 90 天内使用相同的公式。最近创建的组件会从其第一天起显示 uptime since。
- 存在任何停机的时段最多显示 99.99%,绝不会显示 100%。
- 历史记录保留 400 天。新时区适用于新的日期;已记录的日期保留其边界。
订阅源和缓存
页面链接到其事件更新和已发布维护的三个订阅源:RSS 2.0、Atom 1.0 和 JSON Feed 1.1,位于 /api/v1/status/<short name>/feed.rss、feed.atom 和 feed.json。添加 ?lang=es 可获得西班牙语标签。尚不支持电子邮件订阅。
公共地址无需登录,提供成本很低。页面返回 Cache-Control: public, max-age=30 和 ETag,订阅源返回 max-age=300,因此前面的 CDN 或代理可以原样缓存它们。响应带有 Access-Control-Allow-Origin: *,因此其他站点可以读取 JSON。
使页面脱机
- 若要暂时隐藏它,请清除 Published 并保存。其地址会立即返回 not found。
- 关闭功能开关
ui.public_status_page会对所有页面产生同样的效果。 - Delete the page 会删除页面及其组件、事件和可用性历史记录。此操作无法撤消。