# 日志规范

**Repository Path**: wqnmlgbaw/log-specification

## Basic Information

- **Project Name**: 日志规范
- **Description**: 日志+拦截器+过滤器+日志规范test类.
- **Primary Language**: Java
- **License**: Zlib
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2022-06-22
- **Last Updated**: 2024-05-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 日志规范

#### 介绍
日志+拦截器+过滤器+日志规范test类.

#### 软件架构
软件架构说明


#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1.  xxxx
2.  xxxx
3.  xxxx

#### 参与贡献

#### 日志规约
1.<font color=red>【强制】</font>  应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架（SLF4J、
JCL—Jakarta Commons Logging）中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理
方式统一.

2.<font color=red>【强制】</font>  日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。对于当天日志，以 “应用名.log”来保存，保存在/{统一目录}/{应用名}/logs/目录下，过往日志格式为：
{logname}.log.{保存日期}，日期格式：yyyy-MM-dd
正例：以 mppserver 应用为例，日志保存/home/admin/mppserver/logs/mppserver.log，历史日志名称
为 mppserver.log.2021-11-28

3.<font color=red>【强制】</font>  根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不
少于六个月，并且进行网络多机备份。

4.<font color=red>【强制】</font> 应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：
appName_logType_logName.log。logType：日志类型，如 stats / monitor / access 等；
logName：日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什
么目的，也有利于归类查找。
说明：推荐对日志进行分类，将错误日志和业务日志分开放，便于开发人员查看，也便于通过日志对系统进行及时监控。
正例：mppserver 应用中单独监控时区转换异常，如：mppserver_monitor_timeZoneConvert.log

5.<font color=red>【强制】</font> 在日志输出时，字符串变量之间的拼接使用占位符的方式。
说明：因为 String 字符串的拼接会使用 StringBuilder 的 append() 方式，有一定的性能损耗。使用占位符仅是替换动
作，可以有效提升性能。
正例：

    logger.debug("Processing trade with id : {} and symbol : {}", id, symbol);

6.<font color=red>【强制】</font> 对于 trace / debug / info 级别的日志输出，必须进行日志级别的开关判断：
说明：虽然在 debug(参数) 的方法体内第一行代码 isDisabled(Level.DEBUG_INT) 为真时（Slf4j 的常见实现 Log4j 和
Logback），就直接 return，但是参数可能会进行字符串拼接运算。此外，如果 debug(getName()) 这种参数内有
getName() 方法调用，无谓浪费方法调用的开销。

正例：// 如果判断为真，那么可以输出 trace 和 debug 级别的日志

    if (logger.isDebugEnabled()) {
        logger.debug("Current ID is: {} and name is: {}", id, getName());
    }

7.<font color=red>【强制】</font> 避免重复打印日志，浪费磁盘空间，务必在日志配置文件中设置 additivity=false
正例：
    <logger name="com.taobao.dubbo.config" additivity="false">

8.<font color=red>【强制】</font> 生产环境禁止使用 System.out 或 System.err 输出或使用 e.printStackTrace() 打印异常堆栈。
说明：标准日志输出与标准错误输出文件每次 Jboss 重启时才滚动，如果大量输出送往这两个文件，容易造成文件大小
超过操作系统大小限制。

9.<font color=red>【强制】</font> 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字
throws 往上抛出。
正例：logger.error("inputParams: {} and errorMessage: {}", 各类参数或者对象 toString(), e.getMessage(), e);

10.<font color=red>【强制】</font> 日志打印时禁止直接用 JSON 工具将对象转换成 String。
说明：如果对象里某些 get 方法被覆写，存在抛出异常的情况，则可能会因为打印日志而影响正常业务流程的执行。
正例：打印日志时仅打印出业务相关属性值或者调用其对象的 toString() 方法。

11.<font color=blue>【推荐】</font>谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn
来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时
删除这些观察日志。
说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有
人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

12.<font color=blue>【推荐】</font>可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非
必要，请不要在此场景打出 error 级别，避免频繁报警。
说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。

13.<font color=blue>【推荐】</font>尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述
即可，否则容易产生歧义。

14.<font color=blue>【推荐】</font>为了保护用户隐私，日志文件中的用户敏感信息需要进行脱敏处理。
说明：日志排查问题时，推荐使用订单号、UUID 之类的唯一编号进行查询。