Skip to content

Commit a3688df

Browse files
Robert0622roberttwang
andauthored
docs: highlight local agent observability (#18)
Co-authored-by: roberttwang <roberttwang@tencent.com>
1 parent 0257602 commit a3688df

3 files changed

Lines changed: 48 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,30 @@ workflow-summary.md
115115

116116
Resume an interrupted Classic workflow with `/resume-devflow {task_slug}` on CodeBuddy, Cursor, or Claude Code, and with `$devflow-codex resume {task_slug}` on Codex. Each installed host bundle documents its status, abort, and individual-stage commands.
117117

118+
## See how agents work
119+
120+
The Classic Edition for CodeBuddy includes a local observability dashboard. It turns the workflow evidence into a view of session activity, Token and cost trends, Skill/Rule usage, multi-agent dispatch, and Devflow stage attribution—useful for finding expensive runs, checking whether automation is actually being used, and reviewing how work moved between agents.
121+
122+
![LoopForge local agent observability dashboard with demonstration data](docs/assets/agent-observability-dashboard.png)
123+
124+
_Dashboard example using synthetic demonstration data._
125+
126+
The dashboard is generated and served locally; it does not require an external telemetry service. Runtime logs can contain tool arguments and output excerpts, so LoopForge excludes them from Git by default and they should not be shared without review.
127+
128+
<details>
129+
<summary>Open the local dashboard</summary>
130+
131+
After running at least one CodeBuddy session from the project root:
132+
133+
```bash
134+
python3 .codebuddy/skills/agent-observability/scripts/build_dashboard_data.py --project-root .
135+
python3 -m http.server 8765 --directory .codebuddy/skills/agent-observability/scripts/dashboard
136+
```
137+
138+
Open `http://localhost:8765`. See the [observability quickstart](.codebuddy/skills/agent-observability/references/quickstart.md) for data sources, custom pricing, and troubleshooting.
139+
140+
</details>
141+
118142
## When LoopForge is useful
119143

120144
LoopForge is especially useful when:

‎README.zh-CN.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,30 @@ workflow-summary.md
114114

115115
Classic 工作流中断后,CodeBuddy、Cursor 和 Claude Code 使用 `/resume-devflow {task_slug}` 恢复,Codex 使用 `$devflow-codex resume {task_slug}`。状态查看、终止和单阶段命令见安装后对应宿主目录中的 README。
116116

117+
## 看见 Agent 如何完成工作
118+
119+
CodeBuddy 的 Classic Edition 内置本地可观测看板。它把落盘的流程证据变成可视化视图,集中呈现会话活动、Token 与成本趋势、Skill/Rule 使用情况、多 Agent 派发,以及 Devflow 阶段归因,方便定位高成本运行、确认自动化是否真正生效,并复盘任务如何在不同 Agent 之间流转。
120+
121+
![使用演示数据的 LoopForge 本地 Agent 可观测看板](docs/assets/agent-observability-dashboard.png)
122+
123+
_看板示例使用合成演示数据。_
124+
125+
看板的数据聚合和页面服务都在本机完成,不依赖外部遥测服务。运行日志可能包含工具参数和输出片段,因此 LoopForge 默认将它们排除在 Git 之外;未经检查不应对外分享原始日志。
126+
127+
<details>
128+
<summary>打开本地看板</summary>
129+
130+
在项目根目录至少运行一次 CodeBuddy 会话后执行:
131+
132+
```bash
133+
python3 .codebuddy/skills/agent-observability/scripts/build_dashboard_data.py --project-root .
134+
python3 -m http.server 8765 --directory .codebuddy/skills/agent-observability/scripts/dashboard
135+
```
136+
137+
浏览器打开 `http://localhost:8765`。数据源、自定义模型定价和故障排查见[可观测性快速上手](.codebuddy/skills/agent-observability/references/quickstart.md)。
138+
139+
</details>
140+
117141
## 什么时候适合使用
118142

119143
LoopForge 尤其适合这些任务:
113 KB
Loading

0 commit comments

Comments
 (0)