§ 设计文档
§ 一、总体设计
§ 1.概述
运维监控平台系统旨在帮助IT运维人员管理、监控BIP运行平台、管理微服务项目、进行版本控制，把运维人员从单调繁杂的运维工作中解脱出来，使系统的运维工作变得更加简单高效。
§ 2.功能描述
- ICSP监控平台：ICSP监控平台中能够实现微服务jar，WEB项目的上传及部署，可在日志查询中查看收集器收集到的日志内容并进行筛选。
- BIPS监控平台：在BIP监控平台中能够同时管理任意多个BIP运行平台实例，可控制BIP服务器的启停，查看、设置BIP服务器所暴露出来的监控信息，包括客户端连接信息，数据库数据源状态，服务请求状态，JVM CPU、内存状态，提供日志查看，BIP服务器更新等功能。
- 主机管理：用户管理每台服务器上的Agent代理服务，代理服务提供了诸多代理功能，例如文件传输，执行shell脚本命令等。
- 系统管理：用户权限，菜单、功能管理等
§ 3.功能清单
| 一级功能 | 二级功能 | 三级功能 | 说明 |
|---|---|---|---|
| ICSP监控平台 | ICSP监控平台 | 服务登记 | 添加应用服务 |
| ICSP监控平台 | 服务部署 | 部署/停止/重启应用服务 | |
| ICSP监控平台 | 收集器管理 | filebeat日志收集器管理 | |
| ICSP监控平台 | 后台日志配置 | 日志类型及收集日志路径管理 | |
| ICSP监控平台 | 后台日志监控 | 日志内容查看 | |
| BIPS监控平台 | 应用管理 | 服务集群 | 各服务节点状态，服务器文件查看 |
| 应用管理 | 服务登记 | 添加BIP应用服务 | |
| 应用管理 | 版本部署 | BIP应用服务部署 | |
| 应用管理 | 历史预警信息查询 | 历史预警信息查看 | |
| 应用管理 | 表空间使用查看 | 数据库表空间使用情况 | |
| 日志管理 | 设备日志 | 待完善功能 | |
| 日志管理 | 柜员登录信息查询 | 柜员登录信息列表查询 | |
| 日志管理 | 柜员服务器日志查询 | 柜员服务器日志查看、下载 | |
| 配置管理 | 节点配置 | BIP服务端配置 | |
| 配置管理 | 版本服务器配置 | 版本服务器管理 | |
| 配置管理 | 预警阈值配置 | 待完善功能 | |
| 主机管理 | 主机管理 | 代理主机 | Agent代理部署，停止，查看 |
| 主机管理 | 主机分组 | Agent代理的所属分组查看，分配分组 | |
| 主机管理 | 分组维护 | 分组信息的增删改查 | |
| 系统管理 | 系统管理 | 机构管理 | 机构管理 |
| 系统管理 | 用户管理 | 用户管理 | |
| 系统管理 | 功能管理 | 功能管理 | |
| 系统管理 | 菜单管理 | 菜单管理 |
§ 4. 逻辑结构
§ 二、详细设计
§ 1. ICSP监控平台
§ 1.1 服务登记
§ 1.1.1 功能描述
- 选择添加微服务应用或WEB应用，输入应用的各项参数进行保存。
- 能够提前上传该微服务应用或WEB服务的工程包，微服务为jar包，WEB应用为压缩包，上传成功后可以在服务部署功能中选择应用版本进行部署。
§ 1.1.2 流程图
§ 1.2 服务部署
§ 1.2.1 功能描述
- 选择微服务应用或WEB应用，选择需要部署的版本，增加主机实例，将服务部署到对应的主机上。
- 选择对应的实例可以重新部署，重启、停止、删除该应用服务。
- 一个实例即为一个应用在一个主机的部署版本。
- 文件部署进度通过WebSocket向管理端通知。
§ 1.2.2 流程图
§ 1.3 收集器管理
§ 1.3.1 功能描述
- 日志收集器管理：选择主机IP，选择收集配置（指日志收集路径）后提交，将为该主机添加一个FileBeat收集器服务，收集到的日志内容将通过ES中心统一查询。
- 可以启动和停止收集器。
§ 1.3.2 流程图
§ 1.4 后台日志配置
§ 1.4.1 功能描述
- 添加日志配置：输入名称，日志类型，需要收集的日志路径。添加完成后在收集器管理中，添加收集器时可以选择，为某个收集器指定日志收集的路径。
§ 1.4.2 流程图
- 无
§ 1.5 后台日志监控
§ 1.5.1 功能描述
- 查看各个主机上的FileBeat服务收集的日志文件内容
§ 1.5.1 流程图
§ 2. BIPS监控平台
§ 2.1 应用管理-服务集群
§ 2.1.1 功能描述
- 以卡片页的形式，展示各个已配置的BIPS服务端节点状态。点击卡片查看服务器的文件，运行状态，客户端信息，JVM信息监控。通过页面可以启动和停止BIPS服务端平台。
§ 2.1.2 流程图
§ 2.2 应用管理-服务登记
§ 2.2.1 功能描述
- 输入应用名称，部署路径等，添加BIPS类型的应用服务，上传应用包
§ 2.2.2 流程图
§ 2.3 应用管理-版本部署
§ 2.3.1 功能描述
- 选择要部署的应用，选择要部署的版本，选择目标主机进行应用部署。该版本的应用文件将被上传至目标服务器，可选择重启或不重启服务。
§ 2.3.2 流程图
§ 2.4 应用管理-历史预警信息查询
§ 2.4.1 功能描述
- 查看节点主机BIPS的历史预警信息，包含CPU使用率，内存使用率，客户端连接数等。
- 服务度会周期性的执行定时任务，查看服务器的各项指标，一旦指标超过预定阈值，就向数据库中插入警告信息。
§ 2.4.2 流程图
§ 2.5 应用管理-表空间使用查看
§ 2.5.1 功能描述
- 查看当前链接的Oracle数据库表空间使用情况，包含表空间大小，以实用空间，空闲空间等
§ 2.5.2 流程图
- 无
§ 2.6 日志管理-柜员登录信息查询
§ 2.6.1 功能描述
柜员在客户端登录时，通过BIPS向数据库记录登录登出信息
在柜员号查询框内输入柜员号，日期，点击查询，查询到当天登录的柜员信息。
可以实现柜员登录客户端的文件浏览，截屏，查看堆栈信息。
§ 2.6.2 流程图
§ 2.7 日志管理-柜员服务器日志查询
§ 2.7.1 功能描述
- 根据日期和柜员号查询到柜员当天的签到信息，根据客户端IP自动生成客户端该柜员日志的存放路径，根据这个路径可以下载日志文件。
§ 2.7.2 流程图
§ 2.8 配置管理-节点配置
§ 2.8.1 功能描述
- BIPS节点主机的维护，可新增，修改，删除。
- 新增的BIPS节点主机将出现在服务集群页面中。
§ 2.8.2 流程图
§ 2.9 配置管理-版本服务器配置
§ 2.9.1 功能描述
- 版本服务器配置的维护，可查询，新增，修改，删除。
§ 2.9.2 流程图
- 无
§ 2.10.1配置管理-预警阈值配置
§ 2.9.1 功能描述
- 修改服务器指标预警阈值和启停状态，服务端设有定时任务，定期检测服务器状态，一旦某项指标超过设定的阈值上限，就会记录此次信息。
§ 2.9.2 流程图
- 参照《2.4 应用管理-历史预警信息查询》