日志常见等级在实际中的使用说明

      在common-log包中共提供了Fatal、Error、Warn、Info、Debug和Trace六种等级，但是为了简单一般都只使用Error、Warn、Info、Debug和Trace五种等级，下面说明实际中的使用情况。

 

• Trace

      指程序流程记录日志，LOG的最低层次，这种等级一般不推荐常规使用，常规的调试信息推荐使用Debug，输出的信息只有研发人员需要关注，用于最细致的程序逻辑跟踪，一般在频繁的循环中需要记录程序的流程或状态时使用，比如监测调度框架的跟踪记录，常规情况下禁止使用此级别。

 

• Debug

      指调试日志，主要用来详细跟踪程序的执行逻辑以及部分状态信息，常规使用，这些日志一般只需要开发人员、测试人员和实施人员关注，信息尽量详细，可以提供当前程序段相关的数据，便于问题分析。通常情况下发布版本的Log配置文件是不允许Debug之下（包括）的等级信息输出的，一般在以下情况使用：

1. 程序流程或逻辑分支跟踪；
2. 数据或程序状态跟踪；
3. 程序调用时参数传递不合法等日志（一般也要抛出非法参数异常）；
4. 某些会抛出异常但在业务上不算为错误的地方，比如在探测监测某些资源时，可能会抛出异常，但是不算为错误，因为是在探测。

 

• Info

      指信息类的日志，这些信息需要提供给用户、普通技术支持人员查看，信息要求直观易读，能望文生义，一般在以下情况使用：

1. 系统运行跟踪日志，比如用户登陆和重要操作等记录；
2. 重要程序模块的调用，比如加载某模块，使用某功能等；
3. 资源使用记录，比如调用某文件或打印机等；

 

• Warn

      指警告日志，一般指程序运行出现了某些异常，这些异常不会影响业务功能的正常使用，但需要引起注意，针对所有人，更倾向内部技术人员，信息里可以提供当前程序段里一些关键的数据，根据情况可以打印程序中的Exception堆栈，便于问题分析，但不影响程序业务功能执行，一般在以下情况下使用：

1. 程序运行出现异常，但这些异常不影响业务正常使用；
2. 某些应该存在的资源不存在了，但是不影响程序功能的正常运行。

 

• Error

      指错误日志，指程序运行出现了某些错误，这些错误会导致某些业务功能的中断，信息关注者为所有人，信息里可以提供当前程序段里一些关键但非保密的数据，打印程序中Exception堆栈，一般在以下情况使用：

1. 资源使用错误，导致业务功能无法完成；
2. 调用API的方法时有异常抛出，而且异常无法处理（也不能抛出）并影响业务功能时。

 

• Fatal

1. 严重错误信息：针对所有人。用于说明程序执行错误，并由于此错误，程序不得不异常中止；
2. 一般情况下不推荐使用此级别。

 

示例

•  Debug：面向技术

1. 程序执行逻辑，分支：logger.debug("设备SNMP访问失败，将进入NetBios采集");
2. 执行结果统计、状态信息：logger.debug("线程池创建成功，初始化线程数：" + pool.getPoolSize());

 

• Info：面向业务

1. 业务模块运行日志：logger.info("性能快照模块已启动");
2. 业务运行结果：logger.info("本轮性能快照共采集" + total + "个结点");

 

• Warn：有错误，但不影响功能

1. 打开配置文件时，发现配置文件不存在或错误，所以建立一个默认配置文件项：logger.warn("配置文件conf/jdbc.properties不存在，将建立并使用默认配置");

 

• Error：有错误，将影响功能

1.  程序异常退出：logger.error("无法连接数据库，程序即将退出");
2. 执行交换机绑定，由于某种原因，绑定错误，logger.error("设备SNMP访问超时，无法执行绑定");