Orbit

Orbit 状态页面

A status page is a public, no-login URL that shows whether your project is up, how it has performed recently, and what you have deployed. Turning it on also starts an uptime check that pings your…

状态页面是一个公开的、无需登录的 URL,显示您的项目是否正常运行、最近的性能表现以及您部署的内容。启用状态页面后,系统会开始执行正常运行时间检查,每分钟对您的项目执行一次 ping 操作,因此作为发布的副作用,您可以获得监控。

状态页面设置的位置

打开 Orbit,单击项目,然后在项目选项卡栏的 Observability 组下选择 Status page。该页面的标题为 Public status page

Orbit 项目的状态页面设置

启用状态页面

  1. 启用 Enable public status page 开关。
  2. 选择 Public slug。这将成为公开 URL 的一部分,因此请选择可识别的名称,例如您的产品名称。
  3. 可选择设置 Ping path。默认值为 /
  4. 填入公开页面顶部显示的 Page titleTagline
  5. 决定是否启用 Show recent deploysShow recent incidents
  6. 单击 Save settings

保存后,页面会显示 Live 徽章,确认您的状态页面已发布并每分钟执行 ping 操作。一个链接可以带您前往公开页面,以便查看访问者看到的内容。

Slug 规则

slug 必须为小写字母、数字和连字符组成,最多 80 个字符,且不能以连字符开头或结尾。slug 在整个 Orbit 中是唯一的,而不仅仅在您的账户中唯一,因此常见词语可能已被占用。如果已被占用,保存时会返回消息,告知 slug 已被占用,您需要选择另一个。

请仔细选择 slug:这是您将在文档和支持回复中公布的公开地址,稍后更改它会破坏所有指向它的链接。

访问者看到的内容

公开页面是根据您项目自己的选项卡中的相同数据构建的:

  • Current status,来自最近的部署:Operational、Building、Deploying、Queued、Awaiting Approval、Build Failed、Cancelled 或 Rolled Back。
  • Uptime,根据每分钟检查的滚动 24 小时、7 天和 30 天时间窗口计算。
  • Recent deployments,包含成功率(如果您启用了该部分)。
  • 30-day statistics:成功率、平均构建时间和总部署次数。
  • Core Web Vitals,过去 30 天内的 p75(如果您收集这些数据)。
  • Incidents,来自您在项目时间线上标记的注释。

页面会自动刷新,因此在事件期间保持页面打开的客户会看到页面更新,无需重新加载。

页面上的所有内容都是可运行数据:部署状态、响应时间、正常运行时间和指标。提交消息、分支名称、环境变量和您的存储库详情不会被发布。

事件来自时间线

事件部分不是单独的编辑器。它显示来自项目时间线的 Incident 类型的注释,因此在中断期间的工作流程是:标记一个事件注释,它就会公开显示。

这是有意设计的。这意味着您的内部时间线和公开沟通保持同步,无需任何人维护两条记录。有关如何编写注释,请参阅 Orbit Timeline Annotations

编写事件注释时,要像客户会阅读一样,因为他们确实会。说明受影响的内容、您了解到的情况以及下次更新的时间。然后在解决时发布更新注释,而不是让最后的公开信息停留在"正在调查"的阶段。

正常运行时间检查

启用状态页面会启动一个检查,该检查每分钟在您设置的 ping 路径处提取一次您项目的生产 URL。每个结果都会被存储,公开页面上的正常运行时间百分比是根据这些记录计算的。

检查记录保留 90 天,较旧的记录会自动删除。

选择合适的 Ping 路径

默认 / 适用于大多数项目。选择其他路径的两个原因:

  • 您的主页很庞大。 轻量级路径每分钟轮询一次会更公平,成本也更低。
  • 您的主页可以正常工作,但应用可能已损坏。 缓存的静态 shell 在您的 API 宕机时仍会很乐意返回 200。使用 /api/health 之类的路径,实际上会充分利用应用,可以说明真实情况。

如果您已经为自动回滚配置了运行状况检查,在此处使用相同的路径可以使两个信号保持一致。有关运行状况检查设置,请参阅 Deploying Your Project

不要将 ping 路径指向成本高昂的内容,也不要指向需要身份验证的路径。返回 401 或重定向到登录页面的 302 的路径每分钟都会记录为失败,您的正常运行时间将显示为零。

移除状态页面

单击 Remove page 并确认。确认是明确的:所有正常运行时间历史记录都将被删除。

这值得停顿一下思考。移除页面不是暂停按钮。检查会停止,公开 URL 会停止工作,累积的正常运行时间记录也会随之消失。如果您只想让页面暂时不可见,没有隐藏模式:您可以考虑关闭启用开关并保留配置是否比完全移除更适合您。

移除页面时,slug 会被释放,因此之后其他人可以声称使用该 slug。

实用建议

在需要之前发布。 在中断期间创建的状态页面是一个没有人将其加入书签的状态页面。在一切正常时,将链接放在您的页脚、文档和支持签名中。

不要过度承诺。 页面上的正常运行时间数据来自针对一条路径的每分钟检查。这是诚实的监控,不是合同 SLA,不应将其呈现为 SLA。

让标语简短。 它位于标题下方,位于人们在已经感到沮丧时打开的页面上。一行说明服务是什么,别无其他。

故障排除

正常运行时间显示 0% 或远低于实际情况。 ping 路径返回非 2xx 响应。在隐私浏览窗口中打开它:重定向到登录页面、来自不再存在的路径的 404 或地域限制是常见原因。

公开 URL 显示 404。 页面已保存但启用开关已关闭,或者链接中的 slug 与保存的 slug 不匹配。从设置页面复制链接。

slug 被拒绝。 它已被占用、包含无效字符,或以连字符开头或结尾。

公开页面上没有显示指标。 指标来自您网站上的收集器脚本。请参阅 Orbit Web Vitals

即使我们发生过事件,仍然没有事件出现。 注释必须是 Incident 类型,并且 Show recent incidents 开关必须启用。

后续操作

仍需帮助?

请发送邮件至 support@kapsulehost.com 或在 KPanel 中打开聊天。

打开 KPanel