Add local monitor bridge service
This commit is contained in:
71
README.md
71
README.md
@@ -29,7 +29,9 @@ HarborForge.Monitor/
|
||||
├── cmd/harborforge-monitor/ # 程序入口
|
||||
├── internal/config/ # 配置加载
|
||||
├── internal/telemetry/ # 指标采集与上报
|
||||
├── internal/bridge/ # MONITOR_PORT 本地桥接服务
|
||||
├── Dockerfile # 容器化运行
|
||||
├── docker-compose.yml # Docker Compose 配置
|
||||
├── config.example.json
|
||||
└── README.md
|
||||
```
|
||||
@@ -46,7 +48,8 @@ HarborForge.Monitor/
|
||||
"identifier": "vps-nginx-01",
|
||||
"apiKey": "your-api-key",
|
||||
"reportIntervalSec": 30,
|
||||
"logLevel": "info"
|
||||
"logLevel": "info",
|
||||
"monitorPort": 9100
|
||||
}
|
||||
```
|
||||
|
||||
@@ -61,6 +64,24 @@ HarborForge.Monitor/
|
||||
|
||||
同时也兼容旧的/正确拼写的 `HF_MONITOR_*` 变量名。
|
||||
|
||||
### MONITOR_PORT — 插件桥接端口
|
||||
|
||||
当 `MONITOR_PORT` (或 `monitorPort`) 设置为大于 0 的值时,Monitor 会在 `127.0.0.1:<MONITOR_PORT>` 上启动一个本地 HTTP 服务,供 HarborForge OpenClaw 插件查询遥测数据。
|
||||
|
||||
支持的端点:
|
||||
|
||||
| 端点 | 说明 |
|
||||
|------|------|
|
||||
| `GET /health` | 健康检查,返回 Monitor 版本和标识符 |
|
||||
| `GET /telemetry` | 返回最新的遥测数据快照 |
|
||||
|
||||
**重要**:桥接端口是可选的。如果 `MONITOR_PORT` 为 0 或未设置,桥接服务不会启动,Monitor 的心跳上报功能完全不受影响。即使桥接服务启动失败,心跳上报也会继续正常工作。
|
||||
|
||||
环境变量:
|
||||
|
||||
- `MONITOR_PORT` — 首选
|
||||
- `HF_MONITOR_PORT` — 备选
|
||||
|
||||
## 本地开发
|
||||
|
||||
```bash
|
||||
@@ -77,34 +98,46 @@ go build ./cmd/harborforge-monitor
|
||||
docker build -t harborforge-monitor .
|
||||
```
|
||||
|
||||
### 使用 Docker Compose
|
||||
|
||||
```bash
|
||||
# 设置环境变量
|
||||
export HF_IDENTIFIER=my-server
|
||||
export HF_API_KEY=your-api-key
|
||||
export MONITOR_PORT=9100
|
||||
|
||||
# 启动
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### 手动 Docker 运行
|
||||
|
||||
推荐以**宿主机 rootfs 只读挂载**方式运行,这样容器里采集到的是宿主机信息而不是容器自身:
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name harborforge-monitor \
|
||||
--restart unless-stopped \
|
||||
-e HF_MONITER_BACKEND_URL=https://monitor.hangman-lab.top \
|
||||
-e HF_MONITER_IDENTIFIER=vps-nginx-01 \
|
||||
-e HF_MONITER_API_KEY=your-api-key \
|
||||
-e HF_MONITER_REPORT_INTERVAL=30 \
|
||||
-e HF_MONITER_ROOTFS=/host \
|
||||
--network host \
|
||||
-v /:/host:ro \
|
||||
-e HF_MONITER_BACKEND_URL=https://monitor.hangman-lab.top \
|
||||
-e HF_MONITER_IDENTIFIER=my-server \
|
||||
-e HF_MONITER_API_KEY=your-api-key \
|
||||
-e HF_MONITER_ROOTFS=/host \
|
||||
-e MONITOR_PORT=9100 \
|
||||
harborforge-monitor
|
||||
```
|
||||
|
||||
`Dockerfile` 里已经预置了这些环境变量:
|
||||
## systemd
|
||||
|
||||
- `HF_MONITER_BACKEND_URL`
|
||||
- `HF_MONITER_IDENTIFIER`
|
||||
- `HF_MONITER_API_KEY`
|
||||
- `HF_MONITER_REPORT_INTERVAL`
|
||||
- `HF_MONITER_LOG_LEVEL`
|
||||
- `HF_MONITER_ROOTFS`
|
||||
也可以直接用 systemd 运行编译好的二进制:
|
||||
|
||||
## 注意
|
||||
```bash
|
||||
# 编译
|
||||
go build -o /usr/local/bin/harborforge-monitor ./cmd/harborforge-monitor
|
||||
|
||||
- Docker 模式下,建议挂载 `-v /:/host:ro` 并设置 `HF_MONITER_ROOTFS=/host`
|
||||
- 这样 CPU/MEM/LOAD/UPTIME 会通过 host proc/sys 视角采集,磁盘和 nginx 配置也会走宿主机路径
|
||||
- 当前 Nginx site 列表读取的是 `${ROOTFS}/etc/nginx/sites-enabled`
|
||||
- 如果机器没有安装 Nginx,会回报 `nginx_installed = false`
|
||||
- 该客户端不会尝试读取 OpenClaw 信息,`agents` 默认为空,`openclaw_version` 不上报
|
||||
# 复制 systemd unit (见 systemd/ 目录)
|
||||
cp systemd/harborforge-monitor.service /etc/systemd/system/
|
||||
systemctl daemon-reload
|
||||
systemctl enable --now harborforge-monitor
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user