应用系统日志规范

概述

日志设计

日志分类

类别及基本内容

日志类别及基本内容

日志分级

日志级别

日志审计

日志审计要求

内部审计

概述

应用系统日志基本要求、日志管理、日志记录、日志存储、日志采集、日志监控、日志审计和日志销毁相关要求。

日志设计

在应用系统规划和设计前期，应根据系统具体的业务场景规划完善的日志记录方案，日志记录设计基本要求如下：

从数据保护的角度出发，根据 IT 系统承载的业务数据设置合理的日志记录要求，包括但不限

于以下内容：

完整：在保障业务系统稳定运行的前提下，日志记录应完整；
安全：日志记录中对于敏感信息应做脱敏处理或通过适当访问权限控制，避免因日志分析导致业务敏感数据泄密；
可读：日志中不应记录无意义信息，防止无意义的日志淹没重要的信息；
可解析：日志记录应易于解析；
分类：日志应分类分级分别记录；
时效性：日志应被实时、有序记录，记录应及

日志分类

类别及基本内容

日志类别及基本内容

根据应用系统自身及其依赖的软件和硬件环境，应用系统的日志分类包括：操作系统日志、数据库日志、网络设备日志、信息安全设备日志、第三方库和应用框架日志和应用系统自身日志。
每一类日志记录中都应记录以下基本内容：
1. 事件发生的日期和时间；
2. 事件发生的服务器信息，如机器 IP；
3. 事件定位信息，如事件发生的完整路径信息；
应用系统自身日志
应用系统日志，具体细分为以下内容。
1. 运行日志，包括系统运行的过程日志、性能日志、调试日志、调用日志和诊断日志：
2. 业务日志，表示应用系统业务相关的日志，主要包括用户行为日志、业务行为日志、交易日志和诊断日志
3. 第三方库和应用框架日志，此类日志是由应用系统引入的第三方库和第三方技术框架所输出的日志，此类日志内容和格式通常不能更改，但可以配置其日志级别及日志存放位置。为了不干扰应用系统业务日志，推荐将第三方库和第三方框架日志输出到独立文件进行存储。

日志分级

日志级别

当前开发语言提供的日志库都提供多个日志级别，在日志记录时不应将所有信息都记录在同一个日

志级别中，而应根据具体业务场景选取合理的日志级别。日志级别从高到低至少应分为五档，从高到低各日志各级别说明如下：

致命（FATAL）：严重错误。该类错误可导致整个系统或是一系列功能无法使用，甚至导致系统瘫痪、关闭和退出等，如磁盘空间满、数据库不可用等。在某些情况下，若某个业务场景发生的错误需要特别关注时也可使用该级别，如交易支付两次通知支付结果状态不一致。处于该级别的日志表示应立即进行人工干预处理；
错误（ERROR）：普通错误。在程序可以控制的范围内，通常不会造成连锁影响或者重大影响，不会影响系统本身运行，只对单次业务处理有影响。该级别表示虽然发生错误事件，但系统仍可正常运行，错误需尽快修复，只是影响程度比 FATAL 级别稍低。一般用来记录程序中发生的异常错误信息，或者记录业务逻辑出错。例如调用某个接口不通而改调用备选接口，或因用户余额不足扣款失败等。记录该级别日志时，应包括异常发生的堆栈信息、详细的异常信息、异常发生的出处信息等；
警告（WARN）：警告级别。表明会出现潜在错误的情形，不影响系统正常运行，但需要引起注意的警告信息。比如内存不足、使用过期方法等；
信息（INFO）：普通日志信息。系统运行的关键时点的操作信息以及系统运行的关键步骤等信息，一般用于记录业务日志。这个级别记录了系统日常运转中有意义的事件，但同时也应该有足够的信息以用于业务追踪、业务监控及异常排查等；
调试（DEBUG）：程序调试信息。指出细粒度信息事件，用于程序调试和测试。调式信息主要便于开发人员进行错误分析和定位，一般记录一些运行中的细粒度的事件，比如记录某个操作的具体步骤信息。DEBUG 日志仅允许在开发和测试环境开启，如果在生产环境需要开启 DEBUG级别的日志，应征得日志管理人员同意