活字格8.0 update1新功能解密：三十一、活字格服务端日志增强

一、功能总览
活字格 8.0 update1 版本对服务端日志进行了增强，引入了日志模块功能，分模块对服务端不同行为进行记录。举个例子，以前看服务端的审计日志，需要在服务端管理控制台开启，然后在本地生成的 csv 文件查看，到了 8.0 update1 版就可以通过界面在线配置和在线查看，方便了许多。
8.0 update1 版本提出了日志模块的概念，日志模块目前包括：异常日志、HTTP 请求日志、HTTP 响应日志、登录日志、登出日志、审计日志、SQL 执行日志、计划任务执行日志、服务端命令执行日志、忘记密码操作日志、发送邮件日志、结果日志。并且支持在活字格服务器管理控制台对应用的日志模在线配置和在线监测。
先来说说总的增强功能：

• 添加更多的日志来帮助用户的 DevOps 工作；
• 根据日期和大小限制，将日志文件分成多个文件；
• 可配置最大保留日志文件数和天数；
• 可以在管理门户（活字格服务器管理控制台）中查看和查询日志；
• 可以通过更改本地 logConfig 文件来配置/过滤日志内容，并且支持在管理门户对 logConfig 进行配置。
  
  

那么在 8.0 update1 我们如何使用上述增强的日志功能呢？
二、日志文件
活字格服务器上应用或者服务器管理控制台在运行时，就会在本地生成日志文件。
2.1. 日志文件位置
如果要在本地查看这些日志文件，根据活字格服务器部署的环境不同，日志文件存放的位置也不一样。
具体的位置可以登录管理控制台，设置 -> 存储路径 -> 日志存储目录里查看，如下图所示：

2.2. 日志文件内容

本地日志文件以 JSON 格式进行存储，如下所示：

可以看到文件中的一行表示一条日志记录，并用 JSON 格式持久化，方便对日志内容进行解析和进行程序化统计与分析。

注：日志文件中的时间为标准格林尼治时间（GMT），加上 8 小时就是北京时间（GMT+8）。

2.3. 日志文件管理策略

在日志文件的存放位置 ForguncyWebServerLogs 这层目录下，不同应用的日志文件会以应用名分开存放，如下所示：

图中的 log-example 就是发布的应用名称，而 Forguncy.UserService2 文件夹下存放的是活字格服务器管理控制台的运行日志。

每天都会滚动生成新的日志文件，并以 [应用名称][日期].log 的格式进行命名。

• 如果当日单个日志文件大小超过了单个文件大小限制（FileSizeLimitMBytes），会滚动生成多个日志文件，并以下面规则命名：
  

        [APPLICATION NAME][YYYYMMDD]_001.log
        [APPLICATION NAME][YYYYMMDD]_002.log
        …

• 如果总的日志文件数量超过了最大保留日志文件个数限制（RetainedFileCountLimit），会删除最旧的日志文件。
• 如果日志文件的创建时间超过了最长保留天数限制（RetainedFileDaysLimit），其也会被删除。
  

单个文件大小限制（FileSizeLimitMBytes）、最大保留日志文件个数限制（RetainedFileCountLimit）、最长保留天数限制（RetainedFileDaysLimit） 这三个日志管理策略参数都可以通过修改本地日志配置文件或在服务器管理控制台进行配置。

2.4. 日志配置文件

对于上述提到的日志策略可以在日志配置文件中进行配置。

• 发布应用的配置文件在：C:\Users\Public\Documents\ForguncyServer\[ApplicationName]\logConfig.json；
• 活字格服务器管理控制台的配置文件在：[活字格服务器安装根目录]\Forguncy.UserService2\logConfig.json。
  

配置文件部分内容如下所示：

用户可以修改日志配置文件的内容来控制日志记录行为，这里只列出部分配置内容，关于日志模块的配置项会在下篇日志模块进行介绍。

三、日志在线配置和查看

3.1. 在线配置

服务端日志的配置配置除了在配置文件上修改外，还可以在服务器管理控制台通过图形界面修改。

用户登录活字格服务器管理控制台后，在控制台的设置/日志/日志设置模块进行日志配置，如下图所示：

• 选择要进行日志配置的应用；
• 修改最大保留日志文件个数；
• 修改最长保留天数；
• 修改单个日志文件大小限制；
• 选择要配置的日志模块，不同的模块会有不同的配置项；
• 可以选择开启或者关闭某个模块日志；
• 可以开启或关闭模块日志的属性；
• 配置要排除或包含的关键字。
  

修改完配置后记得点击保存按钮，保存日志配置，单击保存后，新配置将立即生效，无需重新启动应用程序或服务器。

3.2. 在线查看

除了在控制台配置日志记录策略外，还可以在控制台的设置/日志/历史日志模块在线查看日志：

• 选择要查看日志的日期；
• 选择要查看日志在选择日期当天的时间段；
• 选择查看日志的应用（可多选）；
• 可以按照日志生成时间进行排序；
• 过滤要查看的日志模块；
• 过滤要查看的日志级别；
• 查看日志详情。
  

好了，这里介绍了 8.0 update1 版本中活字格服务端的配置（本地和在线配置）和在线查看，下篇会对每个日志模块和模块一些属性进行介绍。