waxgourd-addons/beszel-agent/DOCS.md

# Beszel Agent

## 简介

Beszel Agent 是一个轻量级的监控代理，专门用于收集主机系统的 Docker 容器指标和系统性能数据，并将这些数据回传到中央监控服务器（Beszel Hub）

## 功能
- **轻量级**: 比主要解决方案更小，资源占用更少。
- **简单**: 易于设置，无需公网暴露。
- **Docker 统计**: 跟踪每个容器的 CPU、内存和网络使用历史。
- **警报**: 可配置 CPU、内存、磁盘、带宽、温度、负载平均值和状态的警报。
- **多用户**: 用户管理自己的系统。管理员可以在用户之间共享系统。
- **OAuth / OIDC**: 支持多种 OAuth2 提供程序。可以禁用密码验证。
- **自动备份**: 从磁盘或 S3 兼容的存储保存和恢复数据。
- **电池**: 主机系统电池电量。

## 架构
Beszel 由两个主要组件组成：中心 (hub) 和 代理 (agent)。
- **中心 (hub)**: 一个基于 PocketBase 构建的 Web 应用程序，提供用于查看和管理连接系统的仪表板。
- **代理 (agent)**: 在您要监控的每个系统上运行，并将系统指标传递给中心。

## 支持的指标
- **CPU 使用率** - 主机系统和 Docker / Podman 容器。
- **内存使用率** - 主机系统和容器。包括交换分区和 ZFS ARC。
- **磁盘使用率** - 主机系统。支持多个分区和设备(包括移动设备)。
- **磁盘 I/O** - 主机系统。支持多个分区和设备(包括移动设备)。
- **网络使用率** - 主机系统和容器。
- **负载平均值** - 主机系统。
- **温度** - 主机系统传感器。
- **GPU 使用率 / 功耗** - Nvidia, AMD, 和 Intel。
- **电池** - 主机系统电池电量。

## 使用说明
- **启动代理(agent)**: 在加载项商店里找到Beszel Agent并安装。
- **配置代理(agent)并启动**: 将中心(hub)的【添加系统】对话框里自动生成的公钥、令牌和中心(hub)URL地址分别粘贴到代理的配置中，点击【启动】。
- **完成添加系统**: 在中心(hub)URL界面中看到添加的新系统显示为绿色，表示添加成功。
- **注意**: 需要配合中心(Beszel Hub)进行使用。