首页 > 其他分享 >异常日志-日志规约

异常日志-日志规约

时间:2022-09-27 16:00:44浏览次数:45  
标签:正例 输出 规约 使用 debug 日志 异常 强制

异常日志-日志规约

使用日志框架 SLF4J

【强制】应用中不可直接使用日志系统(Log4j、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);

保存日志

异常日志文件保存

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

正例:以 aap 应用为例,日志保存在/home/admin/aapserver/logs/aap.log,历史日志名称为 aap.log.2016-08-01

操作日志保存

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

扩展日志命名方式

【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:

appName_logType_logName.log。logType:日志类型,如 stats/monitor/access 等;logName:日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。

说明:推荐对日志进行分类,如将错误日志和业务日志分开存放,便于开发人员查看,也便于通过日志对系统进行及时监控。

正例:mppserver 应用中单独监控时区转换异常,如:mppserver_monitor_timeZoneConvert.log

输出日志

日志输出

【强制】在日志输出时,字符串变量之间的拼接使用占位符的方式。

说明:因为 String 字符串的拼接会使用 StringBuilder 的 append()方式,有一定的性能损耗。使用占位符仅是替换动作,可以有效提升性能。

正例:

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

避免重复打印日志

【强制】避免重复打印日志,浪费磁盘空间,务必在日志配置文件中设置 additivity=false。

正例:

<logger name="com.taobao.dubbo.config" additivity="false">

生产环境禁止标准日志输出与标准错误输出

【强制】生产环境禁止直接使用 System.out 或 System.err 输出日志或使用e.printStackTrace()打印异常堆栈。

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

异常信息应该包括两类信息

【强制】异常信息应该包括两类信息:案发现场信息 参数与对象异常堆栈信息。如果不处理,那么通过关键字 throws 往上抛出。

正例:

logger.error("inputParams:{} and errorMessage:{}", param.toString(), e.getMessage(), e);

禁止直接用 JSON 工具将对象转换成 String

【强制】日志打印时禁止直接用 JSON 工具将对象转换成 String。

说明:如果对象里某些 get 方法被覆写,存在抛出异常的情况,则可能会因为打印日志而影响正常业务流程的执行。

正例:打印日志时仅打印出业务相关属性值或者调用其对象的 toString()方法。

尽量用英文来描述日志错误信息

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

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

日志级别

trace/debug/info 级别的日志输出

【强制】对于 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());
}

注意日志输出的级别

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

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

谨慎地记录日志

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

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

标签:正例,输出,规约,使用,debug,日志,异常,强制
From: https://www.cnblogs.com/gcbeen/p/16734856.html

相关文章

  • 异常日志-异常处理
    异常日志-异常处理异常定义定义时区分unchecked/checked异常【推荐】定义时区分unchecked/checked异常,避免直接抛出newRuntimeException(),更不允许抛出Excep......
  • django rest-framework 自定义异常捕获类
    djangorest-framework自定义异常捕获类环境:django3.2python3先创建文件exceptions.py(文件名称可以自定义)1、重写exception_handler,自定义异常类#-*-coding:ut......
  • 什么是异常!
     分为2大类:1.Error错误        ----------------------------------------------------------------------------------------------------------------......
  • java异常处理机制
    java异常处理机制异常处理的关键字:trycatchfinallythrowthrowspackagecharpter6.Demo02;​publicclassTest{  publicstaticvoidmain(String[]args){ ......
  • ajax 重复请求、请求超时与网络异常的处理
    重复请求的处理发起一个新的请求之前先判断当前是否有相同的请求正在发送,如果有就取消掉。类似于防抖//标识变量letisSending=false;//是否正在发送AJAX请求btns[......
  • 多视图属性网络异常检测系列一
    论文《DeepAnomalyDetectiononAttributedNetworks》近期会对多视图属性网络异常检测系列进行学习记录这篇虽然不是多视图的,但可以说是属性网络上异常检测的典型,已......
  • java异常--基础内容
    java异常--基础内容异常指程序运行中出现的不期而至的各种状况:文件找不到,网络连接失败,非法参数。。。异常发生在程序运行期间,他影响了正常的程序执行流程。三种类型异常......
  • 异常日志-错误码
    异常日志-错误码错误码的制定错误码的制定原则【强制】错误码的制定原则:快速溯源、沟通标准化。说明:错误码想得过于完美和复杂,就像康熙字典中的生僻字一样,用词似乎精......
  • 日志文件
    <?xmlversion="1.0"encoding="UTF-8"?><configurationscan="true"><contextName>auth</contextName><propertyname="LOG_APP_NAME"value="${LOG_APP_NAME......
  • 分析服务器日志常用命令
    1、查看有多少个IP访问:awk '{print $1}' log_file|sort|uniq|wc-l2、查看某一个页面被访问的次数:grep "/index.php" log_file|wc-l3、查看每一个IP访问了多少......