程序员人生 网站导航

基于Java的开源日志库log4j调研笔记

栏目:服务器时间:2015-07-22 23:20:32

由于Hadoop生态链基本都是java开发的,所以在很多有关大数据处理的开源项目中,常常会看到log4j这个jar包。
本文旨在对它的用法做基本说明。

1. log4j是甚么
从log4j的命名(log for java)不难看出,它是为java提供的日志库。具体而言,它是Apache基金会下的开源项目,它可在不修改利用程序代码的条件下,在程序运行时提供灵活的日志打印功能(固然,利用程序还是必须在代码中调用log4j进行打印,但程序发布后,可以通过配置文件控制日志输出目的地及允许输出的日志等级)。
不管用哪一种语言开发的利用,大量的verbose日志总是会下降程序性能,不过,log4j在设计/实现时已做了很多优化以便尽可能减少对利用程序的性能影响,它的主旨是"speed first, flexibility second",关于log4j性能方面需斟酌的问题,可参考这里的说明。
关于log4j的更多特性,可以通过查看log4j FAQ来了解:What are the features of log4j?"

2. log4j的3要素
log4j存在3个重要概念:loggers, appenders和layouts,这3个要素使得引入log4j库的开发者可以灵活控制打印行动,如日志等级、日志内容、日志格式及打印目的地(如本地或远程打印),等等。
2.1 loggers
事实上,loggers是1些大小写敏感的命名实体,这些实体的命名遵守以下的层级命名规则(细节可查看文档Short introduction to log4j)
A logger is said to be an ancestor of another logger if its name followed by a dot is a prefix of the descendant logger name. A logger is said to be a parent of a child logger if there are no ancestors between itself and the descendant logger.
在loggers的层级结构中,root logger处于最顶级。使用log4j库时,root logger必须被创建且只能通过类静态方法Logger.getRootLogger来创建,而其它logger可以通过传入logger name调用类静态方法Logger.getLogger来实例化。 
可以为logger实例指定日志等级(如通过setLevel接口),目前支持这些经常使用等级:TRACE, DEBUG, INFO, WARN, ERROR, FATAL。不斟酌TRACE,其余等级的重要程度顺次为:DEBUG < INFO < WARN < ERROR < FATAL
若某个logger实例没有显式指定等级,则它会继承距离它最近的、被显式指定过日志等级的父logger实例的等级。
1旦为某个logger实例指定了等级,则调用该实例打印日志时,只有日志等级不小于指定等级的日志会被打印,低于指定等级的日志不会被打印出来。这个规则是log4j库的核心规则,它保证了日志等级的灵活控制
2.2 appenders
appenders其实就是日志打印的目的地址(In log4j speak, an output destination is called an appender),目前支持的appenders包括:console, files, GUI components, remote socket servers, JMS, NT Event Loggers, and remote UNIX Syslog daemons。
1个logger实例可以有多个appender(s),即同1条日志可以同时打印到多个目的地。
默许情况下,某logger实例的日志打印要求会打印到已为该logger实例添加的所有appenders上,另外,该日志打印要求还会沿着logger实例的层级继承链向上传播给其先人logger的所有appenders
例如,为root logger添加console类型的appender后,root logger的日志打印要求会输出到console,这很容易理解。现在假定logger实例C继承自root,且为实例C添加了file类型的appender,则调用实例C进行日志打印时,除file appender会输出日志外,实例C的先人,即本例中的root logger也会收到该日志打印要求,由于root logger添加了console appender,所以,console appender也会输出日志。这个默认行动可以通过将logger的additive字段设置为false来关闭。
关于appender additivity的更多说明及示例,可以参考Short introduction to log4j这篇文档关于Appender部份的说明。
2.3 layouts
layouts可以指定日志的格式,支持的PatternLayout在文档log4j - Class PatternLayout中有详细说明,这里不赘述。

3. log4j的配置
log4j日志库的配置可以在java程序中通过代码指定,也能够通过配置文件来指定并随着java利用的启动被初始化。明显后者更加灵活。
下面是1个典型的log4j配置文件:
log4j.rootLogger=debug, stdout, R log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout # Pattern to output the caller's file name and line number. log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n log4j.appender.R=org.apache.log4j.RollingFileAppender log4j.appender.R.File=example.log log4j.appender.R.MaxFileSize=100KB # Keep one backup file log4j.appender.R.MaxBackupIndex=1 log4j.appender.R.layout=org.apache.log4j.PatternLayout log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n
该配置文件中,只指定了1个logger实例(即root logger),其最低日志等级是DEBUG,添加了2个appender(分别命名为stdout和R)。然后为两个appender name分别指定了log4j真正支持的appender(分别为ConsoleAppender和RollingFileAppender),每一个appender都可以通过layout指定各自的日志格式。

4. log4j库的初始化进程
log4j不对它的使用处景做任何假定,因此,它没有默许的appender,也即,appender必须由使用者显式配置。援用了log4j库的java进程启动时,JVM的classloader机制会对利用程序援用到的Logger类进行加载,而该类的静态初始化函数会尝试自动配置log4j。log4j库默许的初始化进程在文档Short introduction to log4j的"Default Initialization Procedure"部份有详细说明,感兴趣的同学可以去查看。
备注:关于JVM加载class(如系统包或第3方扩大包)的机制,可以通过下面几篇文档来理解:
1) Understanding the Java Classloading Mechanism
2) Understanding Extension Class Loading
3) Internals of Java Class Loading

【参考资料】
1. log4j FAQ: What are the features of log4j?
2. Short introduction to log4j: Ceki Gülcü, March 2002
3. log4j docs: Class PatternLayout
4. Understanding the Java Classloading Mechanism
5. Java Docs:  Understanding Extension Class Loading
6. Internals of Java Class Loading

========================= EOF ========================


------分隔线----------------------------
------分隔线----------------------------

最新技术推荐