SuperAPI AI 工具集

canary

部署与运维

查看项目

更新于 10-16 23:14

技能介绍

用途

canary 是一个部署后监控技能。它在应用上线后,通过无头浏览器持续观察线上应用,用于捕捉发布后出现的问题,例如控制台错误、性能回退、页面失败以及视觉异常。

主要能力

根据提供资料,canary 的监控关注以下方面:

  • 控制台错误(console errors)
  • 性能回退(performance regressions)
  • 页面失败(page failures)
  • 视觉异常(visual anomalies)

在告警策略上,canary 具有两项明确特征:

  • 基于增量而非绝对值进行告警(Alert on deltas not absolutes)
  • 瞬时容忍:需要连续 2 次及以上检查才会判定(transient tolerance,2+ consecutive checks)

此外,canary 默认使用 10 分钟监控窗口(Default 10-minute monitoring window),并提供基线捕获模式(Baseline capture mode)。

使用方式

canary 属于 gstack 技能体系(SKILL.md 结构)。资料中给出的是技能定义文档,包含以下环节:

  • 前置步骤(Preamble,运行一段 bash 脚本):涉及更新检查、会话目录、配置读取(contributor、proactive)、分支与仓库模式判断、遥测状态读取、写会话与遥测日志等。
  • 若 PROACTIVE 为 false,则不主动建议 gstack 技能,仅在用户明确要求时调用。
  • 若输出提示 UPGRADE_AVAILABLE 或 JUST_UPGRADED,按对应升级流程处理。
  • 首次使用时介绍“完整性原则(Completeness Principle / Boil the Lake)”,并可选打开相关文章。
  • 首次使用时询问遥测(telemetry)偏好:社区模式、匿名模式或关闭。
  • AskUserQuestion 格式规范(重新铺垫上下文、用通俗语言解释、给出推荐与完整性评分、列出字母选项)。
  • 仓库所有权模式(solo / collaborative / unknown)下的发现即上报(See Something, Say Something)行为约定。
  • 构建前先搜索(Search Before Building)与三层知识理念,以及 eureka 记录。
  • 贡献者模式(Contributor Mode):在主要工作流步骤后回顾体验,必要时提交字段报告。
  • 完成状态协议(DONE / DONE_WITH_CONCERNS / BLOCKED / NEEDS_CONTEXT)与升级(Escalation)格式。
  • 遥测(Telemetry)在技能工作流结束后记录事件。
  • 计划状态页脚(Plan Status Footer):在 plan mode 下写入 GSTACK REVIEW REPORT 表格。

以上均为该技能文档中描述的通用工作流机制。资料未提供 canary 在具体项目中的安装命令、调用参数或运行示例步骤。

适用场景

适用于对线上应用进行部署后监控的场景,尤其是希望在发布后捕捉控制台错误、性能回退、页面失败和视觉异常,并希望减少因瞬时波动导致的误报(通过连续检查与增量告警)的情况。也可在需要先建立监控基线时使用基线捕获模式。

限制

  • 资料未提供具体的收费、价格或平台支持信息。
  • 资料未提供除默认 10 分钟窗口、连续 2 次检查、基线捕获模式之外的具体阈值或配置项说明。
  • 资料未提供具体的安装命令、依赖要求或完整调用示例。
  • 除上述监控目标(控制台错误、性能回退、页面失败、视觉异常)外,不得假定其他功能。
  • 本文档引用的上游来源标注为 Garry Tan,许可为 MIT;技能文档声明其为自动生成(AUTO-GENERATED),不应直接编辑。

引用文档

以下为作者声明的引用来源,保留指定版本、署名和许可。

作者的来源声明