瀏覽代碼

docs(wecom): align module name and four-tab docs

clm0081 2 天之前
父節點
當前提交
60aad8858a
共有 2 個文件被更改,包括 13 次插入 和 9 次删除
  1. 5 5
      docs/使用说明.md
  2. 8 4
      web-modules/README.md

+ 5 - 5
docs/使用说明.md

@@ -1,8 +1,8 @@
-# WeCom Center — 使用与部署说明
+# ROMAN 定制中心 — 使用与部署说明
 
 > 适用版本:Zabbix **7.4.x**(已在 7.4.16 / MySQL 8.0.43 验证)。
 > 一个自包含、多语言的 Zabbix 前端模块(custom module / plugin)。加载后会在
-> **Administration → WeCom Center** 增加一个定制页面,分 **告警 / 优化 / 日常维护 / L2 拓扑** 四个标签页。
+> **Administration → ROMAN 定制中心** 增加一个定制页面,分 **告警 / 优化 / 日常维护 / L2 拓扑** 四个标签页。
 
 ---
 
@@ -68,7 +68,7 @@ docker compose up -d
 
 ### 2.4 部署验证
 
-1. 左侧菜单出现 **Administration → WeCom Center**,点开能看到三个标签页即成功。
+1. 左侧菜单出现 **Administration → ROMAN 定制中心**,点开能看到四个标签页(告警 / 优化 / 日常维护 / L2 拓扑)即成功。
 2. 打开 **日常维护** 页能搜到触发器、每行右侧有严重度下拉,说明读写链路正常。
 3. 看 `/opt/zabbix/zabbix-server/web-modules/WecomCenter/manifest.json` 与 DB 的 `module` 行(`id=wecom_center,status=1`)。
 
@@ -76,7 +76,7 @@ docker compose up -d
 
 ## 3. 首次初始化(告警链路一键补全)
 
-安装后第一次打开 **WeCom Center → 告警** 页,会显示 **First-time setup / 首次配置**:
+安装后第一次打开 **ROMAN 定制中心 → 告警** 页,会显示 **First-time setup / 首次配置**:
 
 1. 粘贴企业微信群机器人 webhook 的 **Key**(就是 `https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=...` 里 `key=` 后面那串)。
 2. 点 **初始化环境 / Initialise(自检)**。它会自动补齐整条告警链路,**缺啥建啥、已存在则复用**,可反复点当作自检:
@@ -213,7 +213,7 @@ zabbix-deploy/
 
 ---
 
-## 10. L2 物理拓扑(WecomCenter 模块内置)
+## 10. L2 物理拓扑(ROMAN 定制中心模块内置)
 
 ### 10.1 访问入口
 - 展示页:**Monitoring → L2 Topology**,或直接

+ 8 - 4
web-modules/README.md

@@ -1,6 +1,6 @@
-# WeCom Center — 可移植 Zabbix 前端模块
+# ROMAN 定制中心 — 可移植 Zabbix 前端模块
 
-一个自包含、多语言的 Zabbix 7.4 前端模块(custom module / plugin)。加载后会在 **Administration → WeCom Center** 增加一个定制页面,分三个 Tab:
+一个自包含、多语言的 Zabbix 7.4 前端模块(custom module / plugin)。加载后会在 **Administration → ROMAN 定制中心** 增加一个定制页面,分四个 Tab:
 
 - **告警(Alert)**
   - **机器人 key**:单字段读写全局宏 `{$WECOM_KEY}`,无“账号/接收目标”概念(群机器人就是往群里发一条消息);可“发送测试”直接打企微接口看 `errcode`。
@@ -12,6 +12,10 @@
   - **模板切换(迁移设备)**:选“旧模板 → 新模板”,**预览**列出受影响设备 → **确认切换**把每台设备的模板链接替换为新模板(这就是“导入后是否切换”那一步)。
   - **地图标记**:以 **单点(Zabbix server 主机)** 作为代表点,设置 `location_lat` / `location_lon`。
   - **环境初始化 / 自检**:见下文“全新 Zabbix 两步装好”——一键补媒体类型、机器人用户、动作与 `{$WECOM_KEY}` 宏。
+- **L2 拓扑(Topology)**
+  - **只读展示**:STP 指定桥 + MAC 学习生成交换机级联关系,绝不使用 `ifAlias` 猜链路;不写交换机、不创建用户。
+  - **层级与历史**:`防火墙 → 行为管理 → 总核心 → 分核心`;7 天 gzip 历史快照,右上单面板按实际日期/时间回看。
+  - **展示与导出**:告警/离线/延迟/链路速率配色、终端端口矩阵;PNG 导出固定日间模式并把图例烘焙进图片。
 - **日常维护(Maintenance)**
   - **按类别批量改告警等级**:选一个“触发器类别”(如 设备离线 / 硬件故障 / 性能 …)+ 目标严重度,点 **应用**,即把该类别下**模板触发器、触发器原型、已发现(LLD)触发器**一次性改到该等级(复用策略引擎同一套写入逻辑,完全可逆)。适合“把某一类警报统一拉高/压低”。
   - **按单个触发器精确调整**:按名称搜索触发器(最多显示 200 条),对每行可 ①勾选/取消 = 启用/停用告警(写 `trigger.status`,0 启用 / 1 停用);②行尾下拉直接选该触发器的严重度(0–5)。改完点 **保存**,**页面自动刷新**、即时可见(server 配置缓存约 60 秒内同步到告警逻辑)。
@@ -32,7 +36,7 @@
 
 `install.sh` 会在 MySQL 容器可访问时顺手建 L2 表,并在 Zabbix `module` 表已就绪时自动登记/启用 `wecom_center`;若提示表未就绪,再到 **Administration → Modules → Scan directory → 启用 `WecomCenter`**(或执行 README 末尾的 SQL)。
 
-**第二步 —— 点“初始化”**:打开 **WeCom Center** 页面,首次进入会自动显示 **First-time setup**:
+**第二步 —— 点“初始化”**:打开 **ROMAN 定制中心** 页面,首次进入会自动显示 **First-time setup**:
 粘贴群机器人 Key → 点 **Initialise / self-check**。它会自动补齐整条链路(缺啥建啥,已存在则复用、可反复点当自检):
 
 | 对象 | 说明 |
@@ -98,7 +102,7 @@ WecomCenter/
 
    (也可在 Administration → General → Modules 里点“启用”。)
 
-4. 刷新网页,左侧 **Administration → WeCom Center** 即可进入。
+4. 刷新网页,左侧 **Administration → ROMAN 定制中心** 即可进入。
 
 > 换环境:重复 1–3 即可。模块代码放在 git 里,`web-modules/` 随仓库走;MySQL 卷里保存着 `module` 启用记录,二者都在 → 插件始终在线。