BlogJava-aldream-文章分类-Log4j

嵌套诊断环境NDC

aldream — Sun, 11 Nov 2007 06:51:00 GMT

在多用户并发的环境下，通常是由不同的线程分别处理不同的客户端请求。此时要在日志信息中区分出不同的客户端，你可以为每一个线程生成一个Logger，从而从一堆日志信息中区分出哪些信息是属于哪个线程的，但这种方式并不高效。Log4J巧妙地使用了Neil Harrison提出的“NDC（嵌套诊断环境）”机制来解决这个问题。Log4J为同一类别的线程生成一个Logger，多个线程共享使用，而它仅在日志信息中添加能够区分不同线程的信息。NDC是什么？举例来说，如果一个Servlet接到并发请求时，为每一个客户端创建一个新的线程，然后分配一个用于保存该请求上下文的NDC堆栈。该上下文可能是发出请求的主机名、IP地址或其它任何可以用于标识该请求的信息。这样，由于不同的客户端处理线程具有不同的NDC堆栈，即使这个Servlet同时生成多个线程处理不同的请求，这些日志信息仍然可以区分出来，就好像Log4J为每一个线程都单独生成了一个 Logger实例一样。在Log4J中是通过org.apache.log4j.NDC实现这种机制的。使用NDC的方法也很简单，步骤如下：

1. 在进入一个环境时调用NDC.push(String)，然后创建一个NDC；

2. 所做的日志操作输出中包括了NDC的信息；

3. 离开该环境时调用NDC.pop方法；

4. 当从一个线程中退出时调用NDC.remove方法，以便释放资源。

下面是一个模拟记录来自不同客户端请求事件的例子，代码如下：

import org.apache.log4j.Logger;
import org.apache.log4j.NDC;
public class TestNDC {
static Logger log = Logger.getLogger(TestNDC.class.getName());
public static void main(String[] args) {
  log.info("Make sure %x is in your layout pattern!");
  // 从客户端获得IP地址的例子
  String[] ips = {"192.168.0.10","192.168.0.27"};
  for (int i = 0; i<ips.length ; i++)  // 模拟一个运行方法
  {
   // 将IP放进 NDC中
   NDC.push(ips[i]);
   log.info("A NEW client connected, who's ip should appear in this log message.");
   NDC.pop();
  }
  NDC.remove();
  log.info("Finished.");
}
}

注意配置文件中的布局格式中一定要加上%x。系统输出如下：

INFO   - Make sure %x is in your layout pattern!
INFO  192.168.0.10 - A NEW client connected, who's ip should appear in this log message.
INFO  192.168.0.27 - A NEW client connected, who's ip should appear in this log message.
INFO   - Finished.

aldream 2007-11-11 14:51 发表评论

Log4j优化

aldream — Sat, 10 Nov 2007 15:31:00 GMT

一个经常引用的依靠于logging的参数是可以计算的花费。这是一个合理的概念，一个适度的应用程序可能产生成千上万个日志请求。许多努力花在测量和调试logging的优化上。Log4j要求快速和弹性：速度最重要，弹性是其次。
用户应该注意随后的优化建议。
9.1 日志为禁用时，日志的优化
当日志被彻底的关闭，一个日志请求的花费等于一个方法的调用加上整数的比较时间。
在233mhz的Pentium II 机器上这个花费通常在5-50纳秒之间。
然而，方法调用包括参数构建的隐藏花费。
例如，对于logger cat，

logger.debug("Entry number: " + i + " is " + String.valueOf(entry));

引起了构建信息参数的花费，例如，转化整数i和entry到一个string，并且连接中间字符串，不管信息是否被输出。这个参数的构建花费可能是很高，它主要决定于被调用的参数的大小。
避免参数构建的花费应如下，

if(logger.isDebugEnabled() {
logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
}

如果logger的debug被关闭这将不会招致参数构建的花费。另一方面，如果logger是debug的话，它将产生两次判断 logger是否能用的花费。一次是在debugenabled，一次是debug。这是无关紧要的，因为判断日志是否可用只占日志实际花费时间的约1%。
在Log4j里，日志请求在Logger 类的实例里。Logger 是一个类，而不是一个接口。这大量的减少了在方法调用上的弹性化的花费。
当然用户采用预处理或编译时间技术去编译出所有的日志声明。这将导致完美的执行成效。
然而因为二进制应用程序不包括任何的日志声明的结果，日志不可能对那个二进制程序开启。以我的观点，以这种较大的代价来换取较小的性能优化是不值得的。
9.2 当日志状态为启用时，日志的优化
这是本质上的优化logger的层次。当日志状态为开，Log4j依然需要比较请求的级别与logger的级别。然而，logger可能没有被安排一个级别；它们将从它们的father继承。这样，在继承之前，logger可能需要搜索它的祖先。
这里有一个认真的努力使层次的搜索尽可能的快。例如，子logger仅仅连接到它的存在的father logger。
在先前展示的BasicConfigurator 例子中，名为com.foo.bar 的logger是连接到根logger，因此绕过了不存在的logger com和com.foo。这将显著的改善执行的速度，特别是解析logger的层结构时。
典型的层次结构的解析的花费是logger彻底关闭时的三倍。
9.3 日志信息的输出时，日志的优化
这是主要花费在日志输出的格式化和发送它到它的输出源上。这里我们再一次的付出努力以使格式化执行的尽可能快。同appender一样。实际上典型的花费大约是100-300毫秒。
详情看org.apache.log4.performance.Logging。
虽然Log4j有许多特点，但是它的第一个设计目标还是速度。一些Log4j的组件已经被重写过很多次以改善性能。不过，投稿者经常提出了新的优化。你应该满意的知道，以SimpleLayout的配置执行测试已经展示了Log4j的输出同System.out.println一样快。

aldream 2007-11-10 23:31 发表评论

Log4j配置文件

aldream — Fri, 09 Nov 2007 16:43:00 GMT

下面的Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。

1log4j.rootLogger=DEBUG,CONSOLE,A1,im
2log4j.addivity.org.apache=true
3# 应用于控制台
4log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
5log4j.appender.Threshold=DEBUG
6log4j.appender.CONSOLE.Target=System.out
7log4j.appender.CONSOLE.Encoding=GBK
8log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
9log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
10#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n
11#应用于文件
12log4j.appender.FILE=org.apache.log4j.FileAppender
13log4j.appender.FILE.File=file.log
14log4j.appender.FILE.Append=false
15log4j.appender.FILE.Encoding=GBK
16log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
17log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
18# Use this layout for LogFactor 5 analysis
19# 应用于文件回滚
20log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender
21log4j.appender.ROLLING_FILE.Threshold=ERROR
22log4j.appender.ROLLING_FILE.File=rolling.log
23log4j.appender.ROLLING_FILE.Append=true
24log4j.appender.CONSOLE_FILE.Encoding=GBK
25log4j.appender.ROLLING_FILE.MaxFileSize=10KB
26log4j.appender.ROLLING_FILE.MaxBackupIndex=1
27log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout
28log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
29#应用于socket
30log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender
31log4j.appender.SOCKET.RemoteHost=localhost
32log4j.appender.SOCKET.Port=5001
33log4j.appender.SOCKET.LocationInfo=true
34# Set up for Log Facter 5
35log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout
36log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n
37# Log Factor 5 Appender
38log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
39log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
40# 发送日志给邮件
41log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
42log4j.appender.MAIL.Threshold=FATAL
43log4j.appender.MAIL.BufferSize=10
44log4j.appender.MAIL.From=web@www.wuset.com
45log4j.appender.MAIL.SMTPHost=www.wusetu.com
46log4j.appender.MAIL.Subject=Log4J Message
47log4j.appender.MAIL.To=web@www.wusetu.com
48log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout
49log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
50# 用于数据库
51log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender
52log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test
53log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver
54log4j.appender.DATABASE.user=root
55log4j.appender.DATABASE.password=
56log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')
57log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout
58log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
59# 每天新建日志
60log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
61log4j.appender.A1.File=log
62log4j.appender.A1.Encoding=GBK
63log4j.appender.A1.DatePattern='.'yyyy-MM-dd
64log4j.appender.A1.layout=org.apache.log4j.PatternLayout
65log4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L : %m%n
66#自定义Appender
67log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
68log4j.appender.im.host = mail.cybercorlin.net
69log4j.appender.im.username = username
70log4j.appender.im.password = password
71log4j.appender.im.recipient = corlin@cybercorlin.net
72log4j.appender.im.layout=org.apache.log4j.PatternLayout
73log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

aldream 2007-11-10 00:43 发表评论