日志简介

1.1 版本

1.2 功能简介

FineReport 工程运行时，会生成相关日志文件进行记录。

系统日志记录系统运行过程中的一些信息。

2.1 日志级别

系统日志输出级别分为五种：DEBUG、INFO、WARN、ERROR、FATAL。

• 日志级别大小排序（严重程度）：FATAL>ERROR>WARN>INFO>DEBUG

• 日志详细程度排序：FATAL<ERROR<WARN<INFO<DEBUG

2.2 设计器端

设计器端系统日志，记录设计器本地工程运行时的相关日志。

若设计器远程连接服务器工程，日志并不记录到设计器日志中，而是记录到服务器端日志中。

2.2.1 设置日志级别&存储位置

设计器默认的日志级别为ERROR，默认存储在%FR_HOME%\logs\fanruan.log文件中。

打开设计器，点击「文件>选项>高级」，如下图所示：

在「log导出配置」处可修改导出日志存储位置。在「log级别设置」处可根据需求自行调整日志级别。

2.2.3 查看系统日志

用户可在设计器右上角点击打开日志折叠框，然后可在弹出框中查看日志。支持设置日志显示类型，支持清空日志显示界面，支持全选日志方便复制。

设计器日志查看界面默认显示全部日志，用户可自行选择只显示「警告」/「错误」日志，如下图所示：

注：日志查看界面的清空/显示，不会导致日志文件内的记录被删除。

2.3 服务器端

设计器端系统日志，记录服务器端工程运行时的相关日志。

若设计器远程连接服务器工程，日志并不记录到设计器日志中，而是记录到服务器端日志中。

2.3.1 设置日志级别

系统日志默认级别为「ERROR」。

超级管理员登录数据决策系统，点击「管理系统>智能运维>平台日志」，点击「全局设置」，可根据需求自行调整日志级别。如下图所示：

2.3.2 日志存储位置

报表工程部署在服务器上，例如 tomcat 服务器，日志存储在%FR_HOME%\logs\fanruan.log文件里，Tomcat服务器的日志文件catalina.out里也会生成。

不支持修改服务器工程日志存储位置，不支持自动清理%FR_HOME%\logs\fanruan.log文件。

• 用升级工具升级或直接安装 JAR 包为 2019-05-20 及之后的版本的客户，每日 0 点定时将 fanruan.log 压缩，用以节省磁盘空间。

• 通过更换 JAR 升级的客户，可直接删除log4j.properties文件实现日志文件定时压缩功能。

• 如需自定义 log4j 配置需求的用户，请参考文档进行设置：fanruan.log优化

3.1 查看操作日志

操作日志默认存储在%FR_HOME%\webapps\webroot\logs\cubes文件夹中，不支持修改存储位置。

• 常用的操作日志，系统已主动为您分析，详情请参见：平台日志

• 全部的操作日志，存储在cubes文件夹中，可通过数据连接进行查询分析。详情请参见：报表日志 LogDB 数据库

3.2 修改存储位置

操作日志默认存储在%FR_HOME%\webapps\webroot\logs\cubes文件夹中。11.0版本的、Tomcat服务器部署的工程支持修改存储位置。

注：设计器工程不支持修改操作日志的存储位置。

1）Windows 修改%Tomcat%/bin目录下的 catalina.bat 文件，增加配置，配置完成后重启工程。

等于号“=”后面指定路径，相对路径会自动在bin目录下生成logs文件夹，也可使用绝对路径。

set "JAVA_OPTS=%JAVA_OPTS% -DSWIFT_HOME=logs"

2）Linux/Unix 修改%Tomcat%/bin目录下的 catalina.sh 文件，增加配置，配置完成后重启工程。

等于号“=”后面指定路径，相对路径会自动在bin目录下生成logs文件夹，也可使用绝对路径。

JAVA_OPTS="$JAVA_OPTS -DSWIFT_HOME=logs"

3.3 备份操作日志

11.0.4 及之后版本的工程，支持操作日志的实时备份和还原。

3.3.1 实时备份操作日志

管理员登录数据决策系统，点击「管理系统>智能运维>平台日志」，点击「全局设置」，可开启「操作日志实时备份」按钮，如下图所示：

操作日志实时备份的表包括：

• fine_record_execute

• fine_record_operate

• fine_record_email

• fine_record_write

• fine_schedule_record

开启「操作日志实时备份」后，在%FR_HOME%\webapps\webroot\logs\swift_backup下生成备份文件，按照时间戳来分别储存，如20211105。如下图所示：

操作日志每写入一条数据，备份文件中记录一条数据。

备份文件会跟随 3.4 节操作日志的清理逻辑来清理。

3.3.2 还原操作日志

仅当开启了「操作日志实时备份」按钮后，方可进行操作日志的还原。

点击「操作日志备份还原」按钮，跳出日期选择框。选择需要还原的操作日志日期区间，点击「确定」。

耐心等待一段时间后，跳出「备份还原成功」弹窗。操作日志即可成功还原，如下图所示：

注1：若还原过程中刷新页面，再次点击「操作日志备份还原」按钮，会跳出「正在备份」弹窗，请耐心等待即可。

注2：若还原时检测到内存不足，会跳出提示用户清理磁盘

注3：若还原时检测到备份文件损坏，会提示备份文件损坏，不进行备份。

3.4 清理操作日志

超级管理员登录数据决策系统，点击「管理系统>智能运维>平台日志」，点击「全局设置」，可对操作日志文件进行清理，可以设置「自动清理」和「手动清理」。

1）自动清理：每隔 3 个月自动清理一次，保留近 3 个月的数据。最少会保留3个月，最多实际上会有6个月。

2）手动清理：默认保留近 3 个月的数据，可选择 0天、1天、1周、1个月、3个月、6个月、12个月。

注1：「操作日志清理」设置仅影响操作日志的清理，不影响系统日志。

注2：近 3 个月是指当前日期往前 3 个月的数据，例如 2019-8-19 日手动清理，默认保留 2019-5-19 ~ 2019-8-19 日的数据。

注3：清理日志后发现 cubes 文件夹占用空间仍然很大，原因在于只是清理文件夹里面的文件，不会清理文件夹，该目录下文件夹特别多，而且占用比较大的空间。

注4：清理后显示的「当前日志大小」不是磁盘占用空间的概念，而是实际所有文件的大小。详情参见：

• Windows：windows系统中文件大小和占用空间不同的原因解析 

• Linux：du和ls查看文件大小的区别

如下图所示：

3）清理预警

日志文件过大时通知相关用户，相关用户可对日志进行手动清理，减小日志文件大小。

开启预警功能，设置触发条件，例如日志文件大于 xxxM。

短信提醒需要「开启短信功能」，详细设置请查看 短信 ，同时邮件提醒也需要配置发件人，详细设置请查看 邮箱 。

然后勾选「短信提醒」、「平台消息」、「邮件提醒」，再分别设置设置收件人，设置完成后点击「保存」，如下图所示：

短信提醒效果如下图所示：

平台消息效果如下图所示：

邮件提醒效果如下图所示：

补充日志存储在%FR_HOME%\bin\error.txt文件中，不支持修改存储位置。

补充日志主要记录设计器预期外的报错。