Java日志的注意事项

155 阅读6分钟

前言

最近看到了很多有关于在开发或生产环境中怎样打日志的帖子,在此做一下总结。如果以后看到有更多有价值的还会在这篇文章中更新,提醒自己注意。

正文

日志的不同级别

DEBUG : 是最低的限制级别。这个级别只能用于开发和测试环境中,不可以用于生产环境

INFO : 略高于DEBUG的限制级别,我们应该用这个级别记录一些信息型消息比如服务器启动成功,输入的数据,输出的数据等等。

WARN : 限制级别高于INFO,它用来记录警告信息比如客户端和服务器之间的连接中断,数据库连接丢失,Socket达到上限。这些信息是最为重要的,因为你可以在这些信息出现时发出警告,从而让运维团队管理应用程序的运行,并及时处理这些报错。

ERROR : 比WARN的限制级别还高,用于记录ERRORException。你可以在该日志级别上设置警报装置,并且提醒运维团队对之做出处理。ERROR非常重要,你必须将其记录下来

FATAL : 是指可能导致程序终止的非常严重的事件。在这种事件之后你的应用很可能会崩溃。

OFF : 具有最高的级别,旨在关闭JAVA中的日志功能。

这些日志级别是根据slf4j整理的,和java.util.loggingAPI中定义的级别不太一样。java.util.logging还提供了其它的基于问题严重性进行划分的日志级别如SEVERE, FINER, FINEST, FATAL等。

生产环境日志环境搭建

EFK日志收集分析系统

参考:

生产环境搭建EFK日志分析系统 - 简书 (jianshu.com)

一文彻底搞定 EFK 日志收集系统 - 腾讯云开发者社区-腾讯云 (tencent.com)

注意事项

1.将DEBUG日志放在 isDebugEnabled

它能显著的减少因为字符串拼接而带来的性能的影响。

if(logger.isDebugEnabled()){
    logger.debug("java logging level is DEBUG Enabled")
}

2.谨慎的消息的等级

当你在编写服务器端应用时,这一点显得格外的重要,因为它是你观察服务器运行情况的唯一途径。如果你记录了太多的日志,则会影响服务器的性能,但是如果你不记录重要的信息如输入数据和输出数据,那么就很难识别究竟发生了什么问题。

3.使用slf4j或是java.util.loggin

我推荐slf4j因为它的灵活性非常高。它允许在不重启应用的前提下更改日志级别。

4.log4j可以为不同的类配置不同的日志级别

你可以将一些类设置为INFO级别,再将另一些类设置为WARN级别或是ERROR级别。

5.日志的格式化

不要忘了记录线程的名称和完整的JAVA类名,因为如果有多个线程同时在执行这段代码,你可能根本找不出事件序列.

6.从日志中生成报告

在记录日志时要保证一致性和信息性,从而可以分析日志。

7.使用前缀来说明哪一部分代码在打印日志

前缀是指如客户端,数据库或是Session等等。之后你可以使用grep或是find来找到和这些关键字相关的日志。我在进行了这种实践后发现它非常有助于debug或是调查事件,尤其是当日志文件很庞大的时候。你可以将所有数据库级别的日志加上前缀DB_LOG,再将所有SESSION级别的日志加上前缀SESSION_LOG

8.如果某个日志没有分配等级,则将其继承最近级别的等级

这也是为什么我们总是将日志等级分配到根日志上log4j.rootLogger=DEBUG.

9.没有日志和过度日志都是不好的

没有日志的后果自不必多说。但是通常来说,记录日志越频繁,所需的IO操作就越多,从而影响了应用的性能。

10.自检日志并调整日志

最好用英文记录日志,而且要有良好的可读性,从而在查阅时能够快速理解日志。

11.使用标准化格式而不要自行拼接

logger.debug("No of Orders " + noOfOrder + " for client: " + client);//不好
logger.debug("No of Orders {} for client: {}", noOfOrder, client);

12.不要记录敏感信息

不要记录敏感信息如密码,身份证号,信用卡号或账户号。

13.尽量记录决策性信息

比如,一个JAVA应用需要从偏好文件或是环境中加载配置,如果没有找到就使用默认的配置。如果你在使用默认配置,那么你应当记录如下信息:

logger.info("Not able to load personal settings, default Setting selected for user : {}", user);

这个日志丢失了一个关键性信息,为什么无法加载到个人配置?因此如果出现异常的话,还应当记录异常。当然,这条日志也提供了有用的信息,比如究竟是哪个用户遇到了这个问题。

14.一致性

一致性在日志和编码中都很重要。无论你采用哪种格式,你都应当坚持一致性。你应当花些时间仔细考虑日志的格式,从而用它来捕获有用的信息。

15.记录一切出现问题时辅助debug的信息

举个例子,我们经常在应用中将String转化为Date,如果String的格式不正确的话,我们通常会抛出ParseException。但是我经常看到有的代码里捕获了这个异常之后,将Date赋值为null并打印如下日志:

logger.info("failed to convert String to date")

看到这行日志的时候,你根本不知道哪个date传入了不合法的值。它也没有打印出不合法的String的内容究竟是什么。你需要这些信息来解决这个问题。一个更好的日志信息如下:

logger.info("invalid startDate: {}", startDate);

16.异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过关键字throws 往上抛出。

logger.error("xxxxx"+"各参数或者对象.toString()", e);

17.谨慎地记录日志。

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