对于运维平台部署的帆软项目,运维平台提供「备份管理」功能。支持一键备份,支持自动备份,可实现异地备份。
对于运维平台部署的帆软项目,无法使用本文的平台备份还原功能,进行相关内容还原。
请通过运维平台完成:备份项目、还原项目。支持一键备份、自动备份、异地备份。支持一键还原、宕机还原。
1. 概述
1.1 版本
FineBI服务器版本 | 功能变更 |
---|---|
6.0 | - |
1.2 应用场景
用户需要使用旧版本的插件,但插件管理中只能搜到最新版本插件。
用户误删重要的报表和仪表板模板。
用户更新 JAR 后,基于某些原因想要回退。
1.3 功能简介
平台提供备份还原的功能,支持对「平台配置」、「报表模板」、「JAR 包」、「插件」进行备份还原。如下图所示:
1.4 不支持的场景
War 包压缩部署不支持备份还原,War 包非压缩部署支持备份还原。
WebLogic 下 War 包部署时,默认是压缩部署的。WebSphere、Tomcat 下 War 包部署时,默认是非压缩部署的。
2. 备份
2.1 设置备份路径
注:仅超级管理员可设置该路径。
超级管理员登录数据决策系统,点击「管理系统>智能运维>备份还原」,点击「全局设置」按钮,设置备份路径,如下图所示:
默认备份路径为../backup,备份文件存储在工程的%FineBI%/webapps/webroot/backup文件夹下。
用户可修改 backup 文件夹为其他文件夹,但是不支持保存到非工程路径下。
若修改备份路径时去掉前面的../,那么备份文件存储在工程的%FineBI%/webapps/webroot/WEB-INF文件夹下
2.2 备份方式
在「平台配置」、「报表模板」、「JAR 包」、「插件」Tab 页面,均支持手动备份和自动备份两种方式。
2.2.1 手动备份
点击「手动备份」,弹出对话框,可自定义名称,点击「确定」,手动备份完成。如下图所示:
2.2.2 自动备份
超级管理员在「全局设置」中可设置自动备份的「备份频率」、「份数上限」、「备份容量」、「备份失败提醒」等。如下图所示:
各设置项介绍如下表所示:
设置项 | 说明 | 注意事项 |
---|---|---|
备份频率 | 默认为「每周」,自动备份时间是凌晨两点 | - |
份数上限 | 每个模块自动备份上限默认为 5 份 当份数已满上限后,在做新的自动备份时,删除最早一份自动备份 | 份数上限修改后,不立刻生效 下一次触发备份时自动进行检测,并生效 |
备份容量 | 每个模块自动备份可占磁盘默认为 1024 M 当磁盘容量已满后,在做新的自动备份时,删除最早一份自动备份 | 备份容量修改后,不立刻生效 下一次触发备份时自动进行检测,并生效 |
备份失败提醒 | 若自动备份失败后,系统可通过「短信提醒」、「平台消息」、「邮件提醒」 | 短信提醒需要「开启短信功能」,详情请参见:短信 邮件提醒需要「配置邮箱服务」,详情请参见:邮箱 |
2.3 备份的文件
备份的文件默认存放在%FineBI%\webapps\webroot\backup目录下,具体位置如下表所示:
注1:超级管理员可修改备份文件的存放位置,请参见本文 2.1 节。
注2:为提高安全性,自动备份的文件名称后面会加上随机字符,并非乱码。
备份内容 | 简介 | 备份生成的文件夹 |
---|---|---|
平台配置 | 备份系统的平台设置项和FineBI仪表板相关的配置 | config |
报表模板 | 备份%FineBI%\webapps\webroot\WEB-INF\reportlets文件夹中的模板 | reportlets |
JAR 包 | 备份%FineBI%\webapps\webroot\WEB-INF\lib文件夹中的 JAR 包 | jar |
插件 | 备份系统安装的插件 | plugins |
以平台配置举例,备份的文件在 %FineBI%\webapps\webroot\backup\config 下,其中 manual: 手动备份;auto: 自动备份。如下图所示:
2.4 备份管理
支持对备份进行重命名和删除。自动备份和手动备份操作步骤一样。
1)重命名
勾选需要重命名的备份,点击「重命名」,修改命名,点击「确定」即可。如下图所示:
2)删除
勾选需要删除的备份,点击「删除」,点击「确定」,即可删除该备份。如下图所示:
2.5 注意事项
问题描述:
备份失败,报错「java.sql.SQLDataException: data exception: string data, right truncation; table: FINE_CONF_ENTITY column: VALUE」
原因分析:
fine_conf_entity 表中存在数据长度超长,导致备份失败。
解决方案:
方案一:将超长的数据字段筛选出来删掉 。
方案二:仅支持mysql类型的外接数据库使用该方案。
超级管理员可通过「fine_conf_entity可视化配置插件」,修改BackupConfig.customValueLength参数值,来调整最大长度限制,重启服务器后设置生效。如下表所示:
配置项 | 修改规则 |
---|---|
BackupConfig.customValueLength | 参数值需为正整型 默认值为65536 |
3. 还原
3.1 注意事项
3.1.1 被还原版本自动删除
还原某个版本的备份后,被还原版本不会被自动删除,自动对当前版本进行备份。
例如在1号零点备份了一次插件,生成备份A。
2号零点还原备份A时,会自动将2号零点工程使用的插件进行备份,生成备份B。且还原操作完成后,备份A仍然存在。
如需还原的内容比较重要,请在还原前再次备份 2.3 节对应文件夹。或联系技术支持协助进行还原操作。
技术支持联系方式:「服务平台>在线支持」、电话「400-811-8890」。
3.1.2 部分 JAR 在平台配置处不支持还原到某些版本
还原时,部分 JAR 在「平台配置」处不支持还原到某些版本,具体如下表所示:
目前工程 JAR 版本 | 还原到 JAR 版本 |
---|---|
2019-11-08、2019-12-20、2020-01-15 2020-04-03、2020-05-19、2020-07-17 | 2019-04-30、2019-06-14、2019-07-15 2019-08-15、2019-09-18、2019-11-22 |
3.1.3 还原后定时任务可能会立即执行
还原操作可能会对定时任务(例如定时调度、定时备份等)产生影响。
还原后,工程对比当前系统时间,可能会判定定时任务执行遗漏,导致系统定时任务在还原成功后立即执行一次。
3.2 还原方式
点击手动备份/自动备份下备份的文件,点击「还原」按钮,点击「确认」按钮,即可还原备份。如下图所示:
不同内容还原生效的方式略有部分,详情如下表所示:
还原内容 | 描述 |
---|---|
平台配置 | 重启工程后,还原生效 还原后,当前工程下的所有仪表板都会被删除,替换为备份的仪表板 |
报表模板 | 无需重启,立即生效
|
JAR 包 | 重启工程后,还原生效 |
插件 | 无需重启,立即生效 |
注:重启服务器时要保证服务器正常关闭,不能暴力关闭服务器比如直接叉掉 Tomcat 服务器的运行窗口。