日志在编程中的重要性、级别分类及使用日志的注意事项

编程中打印日志的作用：

1）追踪程序运行过程，快速定位问题
2）日志易于记忆和比对
3）成功地调试程序、监控和错误报告地关键是【日志】
4) 追踪数据的变化 ,显示程序运行状态
5) 状态监控：通过实时分析日志，可以监控系统的运行状态，做到早发现问题、早处理问题。
6) 安全审计：审计主要体现在安全上，通过对日志进行分析，可以发现是否存在非授权的操作。

日志的级别分类：

log4j定义了8个级别的log（除去OFF和ALL，可以说分为6个级别），优先级从高到低依次为：OFF>FATAL>ERROR>WARN>INFO>DEBUG>TRACE> ALL。

ALL 最低等级的，用于打开所有日志记录。

TRACE designates finer-grained informational events than the DEBUG.Since:1.2.12，很低的日志级别，一般不会使用。

DEBUG 指出细粒度信息事件对调试应用程序是非常有帮助的，主要用于开发过程中打印一些运行信息。

INFO 消息在粗粒度级别上突出强调应用程序的运行过程。打印一些你感兴趣的或者重要的信息，这个可以用于生产环境中输出程序运行的一些重要信息，但是不能滥用，避免打印过多的日志。

WARN 表明会出现潜在错误的情形，有些信息不是错误信息，但是也要给程序员的一些提示。

ERROR 指出虽然发生错误事件，但仍然不影响系统的继续运行。打印错误和异常信息，如果不想输出太多的日志，可以使用这个级别。

FATAL 指出每个严重的错误事件将会导致应用程序的退出。这个级别比较高了。重大错误，这种级别你可以直接停止程序了。

OFF 最高等级的，用于关闭所有日志记录

如何运用日志及注意事项：

1、制定原则：快速溯源、简单易记、沟通标准化。

2、编程的时候不要图快，在每个阶段结束时，加上打印日志，这样才方便调试程序。

3、在程序里面完成一个部分的代码就添加一条该代码要完成的操作对应含义的打印语句

4、应用中不可直接使用日志系统 （Log 4 j 、 Logback） 中的 API ，而应依赖使用日志框架（SLF4J、JCL–Jakarta Commons Logging） 中的 API ，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

• 说明：日志框架（SLF4J、JCL–Jakarta Commons Logging）的使用方式（推荐使用 SLF4J）

使用 SLF4J：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class);

使用 JCL：

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
private static final Log log = LogFactory.getLog(Test.class);

5、所有日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。对于当天日志，以“应用名.log”来保存，保存在/home/admin/应用名/logs/</font>目录下， 过往日志格式为: {logname}.log.{保存日期}，日期格式：yyyy-MM-dd

• 说明：以 mppserver 应用为例，日志保存在/home/admin/mppserver/logs/mppserver.log，历史日志
  名称为 mppserver.log.2016-08-01

6、应用中的扩展日志 （ 如打点、临时监控、访问日志等 ） 命名方式：appName_logType_logName.log。logType:日志类型，如 stats/monitor/access 等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。

• 说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。
• 正例：mppserver 应用中单独监控时区转换异常，如：mppserver_monitor_timeZoneConvert.log

7、在日志输出时，字符串变量之间的拼接使用占位符的方式。

• 说明：因为 String 字符串的拼接会使用 StringBuilder 的 append()方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。
• 正例： logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);

8、 对于 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());
}

9、避免重复打印日志，浪费磁盘空间，务必在 log 4 j . xml 中设置 additivity = false 。

• 正例：<logger name="com.taobao.dubbo.config" additivity="false">

10、生产环境（发布到现网（已经上线，用户正在使用的系统）的， 用户正在使用的环境）禁止直接使用 System.out 或 System.err 输出日志或使用e.printStackTrace()打印异常堆栈。

• 说明：标准日志输出与标准错误输出文件每次 Jboss 重启时才滚动，如果大量输出送往这两个文件，容易
  造成文件大小超过操作系统大小限制。

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

• 正例：logger.error(各类参数或者对象 toString() + “_” + e.getMessage(), e);

12、日志打印时禁止直接用 JSON 工具将对象转换成 String。

• 说明：如果对象里某些 get 方法被重写，存在抛出异常的情况，则可能会因为打印日志而影响正常业务流
  程的执行。
• 正例：打印日志时仅打印出业务相关属性值或者调用其对象的 toString()方法。

13、谨慎地记录日志。生产环境禁止输出 debug 日志 ； 有选择地输出 info 日志 ； 如果使用warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

• 说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些
  日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

14、可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。

• 说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。

15、尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。

• 说明：国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。

日志的格式

常见的日志格式中对于每一条日志应含有的信息包括日期、时间、脚本的主要任务等要素。
比如要导入文件数据到数据库
正确的日志形式为

yyyy-mm-dd hh:mm:ss load_cpu_data.sh execute load data 2020-06-16_15.txt successful!

举例

在下图程序中分别添加打印语句
1、函数的数据库连接串， 需要打印出来（以方便查看连接DB是否正确，用户名、密码是否正确）
2、连接 DB 成功加打印
3、if连接失败，加打印
4、插入语句执行成功加打印
5、查询成功加打印
6、关闭 DB 连接 加打印
7、程序退出加打印

输出结果：