docs: refresh openclaw plugin architecture docs

This commit is contained in:
zhi
2026-03-21 19:52:09 +00:00
parent 86911286c0
commit f45f5957f4
2 changed files with 17 additions and 14 deletions

View File

@@ -5,9 +5,10 @@
## 当前架构
- HarborForge Monitor Backend 提供服务器注册与遥测接收接口
- OpenClaw Gateway 加载 `harborforge-monitor` 插件
- 插件在 `gateway_start` 时启动 sidecar (`server/telemetry.mjs`)
- sidecar 通过 **HTTP + X-API-Key** 向 Backend 上报遥测
- OpenClaw Gateway 加载 `harbor-forge` 插件
- sidecar (`server/telemetry.mjs`) 已移除
- 插件通过 Gateway/runtime 路径直接提供 OpenClaw 元数据
- Monitor 可选通过本地 `monitor_port` 桥接读取补充信息
## 当前后端接口
@@ -39,7 +40,7 @@
## 数据语义
- `openclaw_version`: 远程服务器上的 OpenClaw 版本
- `plugin_version`: 远程服务器上的 harborforge-monitor 插件版本
- `plugin_version`: 远程服务器上的 `harbor-forge` 插件版本
## 已废弃内容
@@ -67,10 +68,10 @@ Monitor 管理页应提供:
1. 管理员在 Monitor 中注册服务器
2. 管理员为服务器生成 API Key
3. 将 API Key 写入 `~/.openclaw/openclaw.json`
4. 重启 OpenClaw Gateway
5. 插件启动 sidecar
6. sidecar 定时向 `/monitor/server/heartbeat-v2` 上报
4. 如需本地桥接补充信息,配置 `monitor_port`
5. 重启 OpenClaw Gateway
6. 插件直接参与遥测链路;若本地桥接可达,则额外提供 OpenClaw 补充元数据
## 备注
当前保留了对旧 challenge 数据表的**删除兼容清理**(仅为兼容老数据库中的遗留数据),但不再保留 challenge 功能入口运行时逻辑。
当前保留了对旧 challenge 数据表的**删除兼容清理**(仅为兼容老数据库中的遗留数据),但不再保留 challenge 功能入口、WebSocket 方案或 sidecar 运行时逻辑。

View File

@@ -38,13 +38,14 @@
## 语义
- `openclaw_version`: 远程主机上的 OpenClaw 版本
- `plugin_version`: harborforge-monitor 插件版本
- `plugin_version`: `harbor-forge` 插件版本
## 插件生命周期
- 插件注册到 Gateway
- `gateway_start` 启动 `server/telemetry.mjs`
- `gateway_stop` 停止 sidecar
- 插件注册名为 `harbor-forge`
- 不再启动独立 `server/telemetry.mjs` sidecar
- 插件直接通过 Gateway/runtime 路径暴露 OpenClaw 元数据
- 如配置了 `monitor_port`,插件还可通过本地桥接与 HarborForge.Monitor 交互
## 配置位置
@@ -54,13 +55,14 @@
{
"plugins": {
"entries": {
"harborforge-monitor": {
"harbor-forge": {
"enabled": true,
"config": {
"enabled": true,
"backendUrl": "http://127.0.0.1:8000",
"identifier": "vps.t1",
"apiKey": "your-api-key"
"apiKey": "your-api-key",
"monitor_port": 9100
}
}
}