Java日志正确使用姿势

简介: 关于日志,在大家的印象中都是比较简单的,只须引入了相关依赖包,剩下的事情就是在项目中“尽情”的打印我们需要的信息了。但是往往越简单的东西越容易让我们忽视,从而导致一些不该有的bug发生,作为一名严谨的程序员,怎么能让这种事情发生呢?所以下面我们就来了解一下关于日志的那些正确使用姿势。

前言

关于日志,在大家的印象中都是比较简单的,只须引入了相关依赖包,剩下的事情就是在项目中“尽情”的打印我们需要的信息了。但是往往越简单的东西越容易让我们忽视,从而导致一些不该有的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变量为static
private 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
文章来源:深夜里的程序猿

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
XML 消息中间件 JSON
最牛逼的 Java 日志框架,性能无敌,横扫所有对手.....
最牛逼的 Java 日志框架,性能无敌,横扫所有对手.....
214 0
最牛逼的 Java 日志框架,性能无敌,横扫所有对手.....
|
XML 消息中间件 JSON
最牛逼的 Java 日志框架,性能无敌,横扫所有对手。。
Logback 算是JAVA 里一个老牌的日志框架,从06年开始第一个版本,迭代至今也十几年了。不过logback最近一个稳定版本还停留在 2017 年,好几年都没有更新;logback的兄弟 slf4j 最近一个稳定版也是2017年,有点凉凉的意思。 而且 logback的异步性能实在拉跨,功能简陋,配置又繁琐,远不及Apache 的新一代日志框架 - Log4j2 目前来看,Log4j2 就是王者,其他日志框架都不是对手
201 0
最牛逼的 Java 日志框架,性能无敌,横扫所有对手。。
|
14天前
|
算法 Java 开发者
Java中的多线程编程:概念、实现与性能优化
【4月更文挑战第9天】在Java编程中,多线程是一种强大的工具,它允许开发者创建并发执行的程序,提高系统的响应性和吞吐量。本文将深入探讨Java多线程的核心概念,包括线程的生命周期、线程同步机制以及线程池的使用。接着,我们将展示如何通过继承Thread类和实现Runnable接口来创建线程,并讨论各自的优缺点。此外,文章还将介绍高级主题,如死锁的预防、避免和检测,以及如何使用并发集合和原子变量来提高多线程程序的性能和安全性。最后,我们将提供一些实用的性能优化技巧,帮助开发者编写出更高效、更稳定的多线程应用程序。
|
12天前
|
安全 算法 Java
深入理解Java并发编程:线程安全与性能优化
【4月更文挑战第11天】 在Java中,高效的并发编程是提升应用性能和响应能力的关键。本文将探讨Java并发的核心概念,包括线程安全、锁机制、线程池以及并发集合等,同时提供实用的编程技巧和最佳实践,帮助开发者在保证线程安全的前提下,优化程序性能。我们将通过分析常见的并发问题,如竞态条件、死锁,以及如何利用现代Java并发工具来避免这些问题,从而构建更加健壮和高效的多线程应用程序。
|
4天前
|
安全 Java
深入理解 Java 多线程和并发工具类
【4月更文挑战第19天】本文探讨了Java多线程和并发工具类在实现高性能应用程序中的关键作用。通过继承`Thread`或实现`Runnable`创建线程,利用`Executors`管理线程池,以及使用`Semaphore`、`CountDownLatch`和`CyclicBarrier`进行线程同步。保证线程安全、实现线程协作和性能调优(如设置线程池大小、避免不必要同步)是重要环节。理解并恰当运用这些工具能提升程序效率和可靠性。
|
5天前
|
安全 Java
java多线程(一)(火车售票)
java多线程(一)(火车售票)
|
5天前
|
安全 Java 调度
Java并发编程:深入理解线程与锁
【4月更文挑战第18天】本文探讨了Java中的线程和锁机制,包括线程的创建(通过Thread类、Runnable接口或Callable/Future)及其生命周期。Java提供多种锁机制,如`synchronized`关键字、ReentrantLock和ReadWriteLock,以确保并发访问共享资源的安全。此外,文章还介绍了高级并发工具,如Semaphore(控制并发线程数)、CountDownLatch(线程间等待)和CyclicBarrier(同步多个线程)。掌握这些知识对于编写高效、正确的并发程序至关重要。
|
5天前
|
安全 Java 程序员
Java中的多线程并发编程实践
【4月更文挑战第18天】在现代软件开发中,为了提高程序性能和响应速度,经常需要利用多线程技术来实现并发执行。本文将深入探讨Java语言中的多线程机制,包括线程的创建、启动、同步以及线程池的使用等关键技术点。我们将通过具体代码实例,分析多线程编程的优势与挑战,并提出一系列优化策略来确保多线程环境下的程序稳定性和性能。
|
6天前
|
缓存 分布式计算 监控
Java并发编程:深入理解线程池
【4月更文挑战第17天】在Java并发编程中,线程池是一种非常重要的技术,它可以有效地管理和控制线程的执行,提高系统的性能和稳定性。本文将深入探讨Java线程池的工作原理,使用方法以及在实际开发中的应用场景,帮助读者更好地理解和使用Java线程池。
|
6天前
|
存储 安全 Java
Java中的容器,线程安全和线程不安全
Java中的容器,线程安全和线程不安全
15 1