Java日志正确使用姿势
前言
关于日志,在大家的印象中都是比较简单的,只须引入了相关依赖包,剩下的事情就是在项目中“尽情”的打印我们需要的信息了。但是往往越简单的东西越容易让我们忽视,从而导致一些不该有的bug发生,作为一名严谨的程序员,怎么能让这种事情发生呢?所以下面我们就来了解一下关于日志的那些正确使用姿势。
正文
日志规范
命名
首先是日志文件的命名,尽量要做到见名知意,团队里面也必须使用统一的命名规范,不然“脏乱差”的日志文件会影响大家排查问题的效率。这里推荐以projectName_logName_logType.log
来命名,这样通过名字就可以清晰的知道该日志文件是属于哪个项目,什么类型,有什么作用。例如在我们MessageServer项目中监控Rabbitmq 消费者相关的日志文件名可以定义成messageserver_rabbitmqconsumer_monitor.log
。
保存时间
关于日志保存的时间,普通的日志文件建议保留15天,若比较重要的可根据实际情况延长,具体请参考各自服务器磁盘空间以及日志文件大小作出最优选择。
日志级别
常见的日志级别有以下:
- DEBUG级别:记录调试程序相关的信息。
- INFO级别:记录程序正常运行有意义的信息。
- WARN级别:记录可能会出现潜在错误的信息。
- ERROR级别:记录当前程序出错的信息,需要被关注处理。
- Fatal级别:表示出现了严重错误,程序将会中断执行。
建议在项目中使用这四种级别, ERROR、WARN、INFO 、DEBUG。
正确姿势
1、提前判断日志级别
//条件判断 if(logger.isDebugEnabled){ logger.debug("server info , id : " + id + ", user : " + user); } //使用占位符 logger.debug("server info , id : {}, user : {}",id,user);
对于DEBUG,INFO级别的日志,在我们的程序中是比较高频的存在,当我们的项目大了,日志变多了,这时候为了程序运行的效率,我们必须以条件判断或者占位符的方式来打印日志。为什么呢?假如我们项目中配置的日志级别为WARN,那么对于我们下面的日志输出语句logger.debug("server info , id : " + id + ", user : " + user);
,虽然该日志不会被打印,但是却会执行字符串拼接的操作,这里我们的user是一个实例对象,所以还会执行toString方法,这样就白白浪费了不少系统的资源。
2、避免多余日志输出
在我们的生产环境中,一般禁止DEBUG日志的输出,其打印的频率是非常高的,容易对正常运行的程序造成严重的影响,在我们最近的项目中就有遇到过类似的情况。
那么这时候该学会使用additivity属性<logger name="xx" additivity="true">
在这边配置成true的话,也就是默认的情况,这时候当前Logger会继承父Logger的Appender,说白了就是当前日志的输出除了输出在当前日志文件以外,还会输出至父文件里。所以一般情况下,我们为了避免重复打印,会将这个参数设置成false,以减少不必要的输出。
3、保证日志记录信息完整
在我们的代码中,日志记录的内容要包含异常的堆栈,请勿随意输出“XX出错”等简单的日志,这对于错误的调试毫无帮助。所以我们在记录异常的时候一定要带上堆栈信息,例如 logger.error("rabbitmq consumer error,cause : "+e.getMessage(),e);
切记在输出对象实例的时候,须确保对象重写了toString方法,否则只会输出其hashCode值。
4、定义logger变量为staticprivate static final Logger logger = LoggerFactory.getLogger(XX.class);
确保一个对象只使用一个Logger对象,避免每次都重新创建,否则可能会导致OOM。
5、正确使用日志级别
try{ //.. }catch(xx){ logger.info(..); }
这样一来,本来是ERROR的信息,全都打印在INFO日志文件里了,不知情的同事还会在死盯着错误日志,而且还找不出问题,多影响工作效率是吧?
6、推荐使用slf4j+logback组合
logback库里自身就已经实现了slf4j的接口,就无需引入多余的适配器了,而且logback也具有更多的优点,建议新项目可以使用这个组合。 还有一点需要注意,当引入slf4j后,要注意其实际使用的日志库是否是由我们引入的,也有可能会使用了我们第三方依赖包所带入的日志库,这样就可能会导致我们的日志失效。
7、日志的聚合分析
日志的聚合可以把位于不同服务器之间的日志统一起来分析处理,如今ELK技术栈亦或者的EFG(fluentd+elasticsearch+grafana)等都是一些比较成熟的开源解决方案。
拿ELK来说,可以在我们的服务器上直接通过logstash来读取应用打印的日志文件,或者也可以在我们项目中的日志配置文件里配置好相关的socket信息,打印的时候直接把日志信息输出至logstash。再交由elasticsearch存储,kibana展示。
本文作者: wangzenghuang
文章来源:深夜里的程序猿
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
搭建高校AI大数据实训室,2019高校大数据科研教学整体解决方案
伴随着互联网技术的迅猛发展,正在逐步改变传统的高校教育模式,以大数据、云计算、AI等等技术为核心的教育模式正在逐步发展。 高校实行AI大数据实训室有何实质性的效果呢? 大数据的出现催生出产业人才缺口瓶颈,在大数据挖掘项目的实施方面,被调查公司普遍缺乏相关的技术能力。75%以上的公司表示在人员和培训方面存在障碍,会大数据挖掘技术的人才很热门,但是比较难找而且昂贵,会 Hadoop 技术的数据挖掘人才更是奇缺。 虽然大数据目前在国内还处于初级阶段,但是其商业价值已经显现出来,特别是有实践经验的大数据分析人才更是各企业争夺的热门。为了满足日益增长的大数据分析人才需求,很多大学开始尝试开设不同程度的大数据分析课程。“大数据分析”作为大数据时代的核心技术,必将成为高校数学与统计学专业的重要课程之一。 目前高校大数据教学的主要困境:教师资源严重不足、尚未建立起合理的大数据教学体系、实践教学平台搭建困难、大数据实践应用案例缺乏、学生缺少实战机会。 数道云大数据提供专业的Hadoop、spark等大数据主流课程,助力高校大数据分析课程教学,培养大数据多种实用型技术人才。基于数据的采集、存储、计算和大数...
- 下一篇
SpringBoot构建大数据开发框架
为什么使用SpringBoot1、web工程分层设计,表现层、业务逻辑层、持久层,按照技术职能分为这几个内聚的部分,从而促进技术人员的分工 2、需要各种XML配置,还需要搭建Tomcat或者jetty作为容器来运行,每次构建项目,都需要经历此流程 3、一个整合良好的项目框架不仅仅能实现技术、业务的分离,还应该关注并满足开发人员的“隔离” springBoot是什么 Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架致力于实现免XML配置,提供便捷,独立的运行环境,实现“一键运行”满足快速应用开发的需求。从而使开发人员不再需要定义样板化的配置。 从根本上讲,Spring Boot就是一些库的集合,它能够被任意项目的构建系统所使用。 它的优点 使编码变得简单 spring boot采用java config的方式,对spring进行配置,并且提供了大量的注解,极大地提高了工作效率。 使配置变得简单 spring boot提供许多默认配置,当然也提供自定义配置。但是所有spring boot的项目都只有一个配置文件...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- SpringBoot2整合MyBatis,连接MySql数据库做增删改查操作
- CentOS6,CentOS7官方镜像安装Oracle11G
- Springboot2将连接池hikari替换为druid,体验最强大的数据库连接池
- Jdk安装(Linux,MacOS,Windows),包含三大操作系统的最全安装
- SpringBoot2更换Tomcat为Jetty,小型站点的福音
- CentOS8安装Docker,最新的服务器搭配容器使用
- CentOS8,CentOS7,CentOS6编译安装Redis5.0.7
- 设置Eclipse缩进为4个空格,增强代码规范
- Docker使用Oracle官方镜像安装(12C,18C,19C)
- CentOS8编译安装MySQL8.0.19