Files
heicode-win/docs/milestones/M5-observability-visualization.md
T

2.5 KiB
Raw Blame History

M5 · 可观测性与可视化(运行态对外)

目标

为 有状态执行单元 提供 可视化与可观测接口,并与产品分工对齐(详见 ../integration/agnet-platform-api-design.md §1.1):

  • Heicode Manager:展示 Agnet 平台回传的 运行态与性能类字段(是否在跑、阶段、健康、资源占用、聚合指标、近期错误摘要等),支撑控制台与运维信任。
  • Heicode 客户端:在编码与工作会话中 实时展示子 Agnet 输出内容(流式增量等),与会话上下文同屏,降低「黑盒」带来的协作摩擦。

团队与个人均可使用上述能力;差异在 信息类型(平台状态 vs 会话内子代理产出),不在用户类别。

完成定义(DoD)

  • 快照 API:按 agent_id / deployment_id 返回结构化状态(阶段、版本、最近心跳、队列深度等字段见集成文档 §6.1)—— 主要支撑 Manager 侧平台运行态。
  • 子 Agnet 输出流:会话内子执行单元产出可通过 SSE/WS 或等价协议增量下发(集成文档 §6.4),Heicode 客户端可订阅并与编码界面联动。
  • 事件流:支持 SSE 或 WebSocket 订阅单实例或项目级 生命周期/运行态 事件;含断线重连与 Last-Event-ID 语义(集成文档 §7);与「输出增量」事件类型可区分。
  • 聚合视图:项目级 Dashboard 所需指标(活跃单元数、失败率、平均耗时)可由 Agnet 聚合端点提供,或约定由 Heicode Manager 拉取后缓存(二选一须文档化)。
  • 与权限联动:只读角色仅能访问允许范围内的实例;事件流不得泄漏其他租户 ID。
  • SLI 约定:可选暴露 RED/USE 类指标端点(Prometheus 或 JSON),便于接入现有监控。

依赖

  • M3(实例存在)
  • M4(否则可视化接口本身成为数据泄漏面)

与 Agnet 的衔接

  • 对齐集成文档 §1.1(职责划分)、§6(含 §6.4 子代理输出)、§7(事件流)。

验收建议

  • 业务方 UAT:非技术成员能否从 UI 判断「卡在哪一步」。
  • 负载测试:事件流在 N 并发订阅 下仍满足延迟上限(自定阈值)。

风险

  • 若事件 schema 不版本化,客户端与平台升级易出现「半屏空白」——需 schema 版本 字段。