博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
阿里巴巴日志规约
阅读量:6229 次
发布时间:2019-06-21

本文共 1998 字,大约阅读时间需要 6 分钟。

hot3.png

日志规约

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

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

2. 【强制】日志文件推荐至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。
3. 【强制】应用中的扩展日志(如打点、临时监控、访问日志等) 命名方式:
appName_logType_logName.log。logType:日志类型,推荐分类有 stats/monitor/visit 等;
logName:日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类
型,什么目的,也有利于归类查找。
正例: mppserver 应用中单独监控时区转换异常,如:
mppserver_monitor_timeZoneConvert.log
说明: 推荐对日志进行分类, 如将错误日志和业务日志分开存放,便于开发人员查看,也便于
通过日志对系统进行及时监控。
4. 【强制】对 trace/debug/info 级别的日志输出,必须使用条件输出形式或者使用占位符的方
式。
说明:

logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);

如果日志级别是 warn,上述日志不会打印,但是会执行字符串拼接操作,如果 symbol 是对象,
会执行 toString()方法,浪费了系统资源,执行了上述操作,最终日志却没有打印。
正例: (条件)

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

正例: (占位符)

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

5. 【强制】避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false。
正例: <logger name="com.taobao.dubbo.config" additivity="false">
6. 【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过
关键字 throws 往上抛出。
正例: logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);

public static void main(String[] args) {        String a = "a";        String b = "b";        String c = "c";        Exception e = new Exception("我是异常信息");        // 6. 【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。        // 如果不处理,那么通过关键字 throws 往上抛出        // 使用条件输出形式或者使用占位符的方式。        logger.error("a = {}, b = {}, c = {}, Exception info:{}", a, b, c, e.getMessage(), e);    }

173217_j8lq_3071470.png

7. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志; 有选择地输出 info 日志; 如果使
用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘
撑爆,并记得及时删除这些观察日志。
说明: 大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。 记录日志时请
思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?
8. 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适
从。如非必要,请不要在此场景打出 error 级别,避免频繁报警。
说明: 注意日志输出的级别, error 级别只记录系统逻辑出错、异常或者重要的错误信息。

 

转载于:https://my.oschina.net/hutaishi/blog/1617008

你可能感兴趣的文章
Dynamips ADSL实验之一pppoeoa(工大瑞普修正版)
查看>>
SQL Server 2012 Always on Availability Groups安装Step by step 1
查看>>
磁盘及文件操作命令
查看>>
shell 学习之case语句
查看>>
体验async/await异步编程
查看>>
Mac OS Mavericks “本地项目”钥匙串
查看>>
用winhex给自己的文件加把锁
查看>>
烂泥:阿里云RDS本地恢复数据
查看>>
php连接oracle测试和pdo连接mysql测试
查看>>
天兔(Lepus)数据库监控系统快速安装部署
查看>>
设置GRUB密码及重置密码
查看>>
使用组策略配置域中计算机系统更新
查看>>
Seam的中文化支持
查看>>
NetBeans 开发 Applet
查看>>
Git学习教程(五):Git标签
查看>>
域环境配置ISA2006企业版存储服务器及NLB之一配置存储服务器
查看>>
[IE 技巧] 显示/隐藏IE 的菜单/工具栏
查看>>
微软私有云分享(R2)2-服务模板的变量
查看>>
足球防守技巧
查看>>
kettle job如何利用java的反射机制获取执行的sql语句
查看>>