debug的记录

系统日志

when 我需要在什么时候打印日志

代码调试
问题定位
用户行为日志（记录操作日志）
根因分析

where我会在哪打印我的日志

1.程序入口：入参

在入口打印日志是因为这个时候传递进来的参数没有经过任何处理，将它打印在日志文件中能一眼就知道程序的原始数据是否符合我们的预期，是不是传递进来的原始数据就出现 的问题。

2.异常捕获：try…catch

在异常打印出详细的日志能让你快速定位错误在哪里，例如在程序抛出异常捕获时，在平时我们经常就是直接在控制台打印出堆栈信息e.printStackTrace()，但在实际的生产环境更加艰苦，更别说有IDE来让你查看控制台信息，此时就需要我们将堆栈信息记录在日志中，以便发生异常时我们能准确定位程序在哪里出错。禁止出现捕获异常不做任何处理的行为，不能直接将异常打印到控制台。

3.重要信息:

这一点可能很宽泛，因为不同的业务逻辑重点可能并不一样，例如在有的重要参数不能为空，此时就需要判断是否为空，如果为空则记录到日志中；还有的例如传递进来的参数经过一系列的算法处理过后，此时也需要打印日志来查看是否计算正确。但切记，尽量不要直接在for循环中打印日志，特别是for循环特别大时，这样你的日志可能分分钟被冲得不见踪迹，甚至带来性能上的影响。

示例

1、增删改操作需要打印参数日志（以便定位一些异常业务问题）；

2、条件分支需要打印日志：包括条件值以及重要参数；

3、明确日志打印级别与包含的信息

1）提供方服务，建议以 INFO 级别记录入参，出参可选

2）消费队列消息，务必打印消息内容

3）调用方服务，建议以 INFO 级别记录入参和出参

4）运行环境问题，如网络错误、建议以 WARN 级别记录错误堆栈

5）定时任务，务必打印任务开始时间、结束时间。涉及扫描数据的任务，务必打印扫描范围

4、异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws/throw 往上抛出，由父级方法处理

5、谨慎地记录日志

1）生产环境禁止输出 debug 日志

2）有选择地输出 info 日志

3）如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志

6、可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从

注意日志输出的级别，error 级别只记录系统逻辑出错、异常等重要的错误信息。如非必要，请不要在此场景打出 error 级别。(上述已经说明了 error 与 warn 级别日志的区别)

7、对 trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式
8、不允许记录日志后又抛出异常，因为这样会多次记录日志，只允许记录一次日志

反例：

if (virtualIpPortCrash) {
            log.error("接入虚拟IP端口冲突");
            throw new BusinessException("接入虚拟IP端口冲突");
        }

9、不允许出现System print(包括System.out.println和System.error.println)语句作为日志的打印

10、不允许出现 e.printStackTrace

11、日志性能的考虑。如果代码为核心代码，执行频率非常高，则输出日志建议增加判断，尤其是低级别的输出

12、【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一

import lombok.extern.slf4j.Slf4j;
//1-在类上添加注解
@Slf4j 

//2-直接使用log.info()进行日志的打印（还支持error、warn、trace以及debug等级别）
log.info("service update success:{}................",serviceEntity.getName());

13、【强制】日志文件推荐至少保存 15 天，因为有些异常具备以“周”为频次发生的特点

14、【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式： appName_logType_logName.log

logType:日志类型，推荐分类有 stats/desc/monitor/visit 等

logName:日志描述。这种命名的好处：通过文件名就可知 道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。 正例：mppserver 应用中单独监控时区转换异常，如： mppserver_monitor_timeZoneConvert.log

15、【强制】避免重复打印日志，浪费磁盘空间。务必在 log4j.xml 中设置 additivity=false

WHAT 我要打印什么：便于定位

应该打印什么内容？打印的内容一定要从实际出发。也就是说如果在实际的生产环境中，你的用户量很大，日志在不停地刷新，如何定位某个用户的整个登录以及后续的操作呢？当然就是根据用户名来跟踪。所以打印内容的第一要素就是要能便于定位；定位过后也许用户在好几个模板中进行操作，还是定位，这个时候定的是模块 的位；还有一点当然就是用户操作时的具体参数；最后一点就是用户干了什么。
　　总结就是，[id, module, params, content]（关键字，模块，参数，内容）。
　　打印的内容：使用占位符打印日志而非用字符串拼接的方式。

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

how 我的日志规范

• 对程序运行情况能够进行记录和监控
• 在必要时可详细了解程序内部的运行状态
• 对系统性能的影响尽量小（代码中打印方式、打印的日志量与日志存储等方面）
  原文地址：https://www.cnblogs.com/yulinfeng/p/7689388.html
  原文地址：https://zhuanlan.zhihu.com/p/373421979