日志规范

日志基本格式

• 时间
• 日志级别
• 链路标识
• 线程名称
• 日志记录器名称
• 日志内容
• 异常堆栈（可有、可无）

2021-01-06 11:49:15.588|http-nio-4051-exec-49|INFO |c.g.common.bean.aop.ControllerAop:120|TID:904306b8775844cc8d067ac8b4167cb1.166.16099049555710223|Controller AOP

日志时间

• 日志基本以天为维度进行滚动

日志级别

• DEBUG

DEUBG 级别的主要输出调试性质的内容，该级别日志主要用于在开发、测试阶段输出。该级别的日志应尽可能地详尽，便于在开发、测试阶段出现问题或者异常时，对其进行分析

• INFO

INFO 级别的主要输出提示性质的内容，该级别日志主要用于生产环境的日志输出。该级别或更高级别的日志不要出现在循环中，可以在循环开始或者结束后输出循环的次数，以及一些其他重要的数据。
应用启动时所加载的配置参数值（比如：连接参数、线程池参数、超时时间等，以及一些与环境相关的配置，或者是整个配置参数）
一些重要的依赖注入对象的类名
方法（服务方法）的输入参数值、返回值，由于一些方法入参的值非常多，只在入口处输出一次就可以了，在服务方法内部或者调用非服务方法时就不需要再输出了
方法中重要的部分，比如：从数据库中所获取较为重要的数据，以及调用第三方接口的输入参数值和接口返回值
INFO 级别日志原则是在生产环境中，通过 INFO 和更高级别的日志，可以了解系统的运行状况，以及出现问题或者异常时，能快速地对问题进行定位，还原当时调用的上下文数据，能重现问题。
建议在项目完成后，在测试环境将日志级别调成 INFO，然后通过 INFO 级别的信息看看是否能了解这个应用的运用情况，如果出现问题后是否这些日志能否提供有用的排查问题的信息

• WARN

WARN 级别的主要输出警告性质的内容，这些内容是可以预知且是有规划的，比如，某个方法入参为空或者该参数的值不满足运行该方法的条件时。在 WARN 级别的时应输出较为详尽的信息，以便于事后对日志进行分析

log.warn("[{}] name is null",methodName);

• ERROR

  ERROR 级别主要针对于一些不可预知的信息，诸如：错误、异常等，比如，在 catch 块中抓获的网络通信、数据库连接等异常，若异常对系统的整个流程影响不大，可以使用 WARN 级别日志输出。在输出 ERROR 级别的日志时，尽量多地输出方法入参数、方法执行过程中产生的对象等数据，在带有错误、异常对象的数据

  log.error("[{}] name is null",methodName,e);

调用链路标识

在分布式应用中，用户的一个请求会调用若干个服务完成，这些服务可能还是嵌套调用的，因此完成一个请求的日志并不在一个应用的日志文件，而是分散在不同服务器上不同应用节点的日志文件中。该标识是为了串联一个请求在整个系统中的调用日志

线程名称

输出该日志的线程名称，一般在一个应用中一个同步请求由同一线程完成，输出线程名称可以在各个请求产生的日志中进行分类，便于分清当前请求上下文的日志

日志记录名称

日志记录器名称一般使用类名，日志文件中可以输出简单的类名即可，看实际情况是否需要使用包名。主要用于看到日志后到哪个类中去找这个日志输出，便于定位问题所在

日志内容

• 隐私信息内容脱敏

  类型	要求	示例	说明
  密码	不输出	**** **	登录密码、支付密码等各种类型的密码
  信用卡 CVV2	不输出	***
  信用卡有效期	不输出	****
  验证码	不输出	**** **	图形验证码、短信验证码、邮件验证码等
  密钥、盐	前 5 后 5	**** **	用于加解密算法的密钥，消息摘要的盐，以及数字签名及签名验证算法所使用的公私钥对等
  会话 ID设备指纹 (ID)指纹 token密文数据	前 5 后 5	xxx***xxx	主要有以下类型：1. 应用的会话标识，比如：Web、APP、H5 等用于识别会话状态信息的标识2. APP 标识设备的设备指纹或者设备 ID3. APP 用于指纹验证的 token 4. 密文数据指的是加密后的数据被掩码的字符无论多少位都输出 3 个 *
  银行卡卡号	前 6 后 4	4401666**** **0083	银行卡卡号最多 19 位数字
  手机号	前 3 后 4	135**** 9527	定长 11 位数字
  身份证号	前 1 后 1	6**** **X	定长 18 位
  姓名	隐姓	*老三	将姓氏隐藏
  IP 地址	前 1 后 1	10...27	隐藏 IP 地址的第 2、第 3 段
  邮箱地址	前 1 后 1	w**3@gmail.com	仅对 @ 之前的邮箱名称进行掩码，掩码部分不管多少位均输出 ** *
  地址	隐号码	上海市西藏北路 * 号 ** * 楼 * 室

异常堆栈

异常堆栈一般会出现在 ERROR 或者 WARN 级别的日志中，异常堆栈含有方法调用链的系统，以及异常产生的根源。异常堆栈的日志属于上一行日志的，在日志收集时需要将其划至上一行中

日志文件

日志文件放置于固定的目录中，按照一定的模板进行命名，推荐的日志文件名称：

• 应用日志命名：当前正在写入的日志文件名：<应用名>[-<功能名>].log
• 移动日志命名：<设备>[-<功能名>].log

日志配置

根据不同的环境配置不同的日志输出方式：

• 本地调试可以将日志输出到控制台上
• 测试环境或者生产环境输出到文件中，每天产生一个文件，如果日志量庞大可以每个小时产生一个日志文件
• 生产环境中的文件输出，可以考虑使用异步文件输出，该种方式日志并不会马上刷新到文件中去，会产生日志延时，在停止应用时可能会导致一些还在内存中的日志未能及时刷新到文件中去而产生丢失，如果对于应用的要求并不是非常高的话，可暂不考虑异步日志

logback 日志工具可以在日志文件滚动后将前一文件进行压缩，以减少磁盘空间占用，若使用 logback 对于日志量庞大的应用建议开启该功能。

赏

谢谢你请我吃糖果