openfire日志配置

本文记录openfire开发过程中日志配置。

在开发openfire时有时需要将更多的日志信息打印到控制台或者修改日志的输出等级添加或减少日志的保留数。此时需要配置openfire的日志。

1、配置文件

openfire的日志配置文件存放在源码的build/lib/dist目录下，文件名log4j.xml。

打开文件可以看到默认情况下openfire会将日志输出到4个不同级别的文件中，文件存储路径在openfire源码下的target/openfire/logs目录下且默认是输出大于info级别的日志。

2、添加输出控制台的配置

打开log4j.xml配置文件，并在其中加入输出日志到控制台的配置。如下：

<!-- add begin -->  
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">  
        <layout class="org.apache.log4j.PatternLayout">  
            <param name="ConversionPattern" value="%-5p %d{yyyy-MM-dd HH:mm:ss}   %c{1}:%L - %m%n" />  
        </layout>  
    </appender>  
    <!-- add end -->            

然后修改root节点中的配置，加入输出日志到上面的控制台配置中。本文还同时将日志级别调整为debug。

<root>
        <level value="debug" />
        <appender-ref ref="STDOUT" />
        <appender-ref ref="debug-out" />
        <appender-ref ref="info-out" />
        <appender-ref ref="warn-out" />
        <appender-ref ref="error-out" />
    </root>           

其余的配置如拆分文件、文件命名等等可以自行查阅参考log4的配置。本文不过多赘述。

如下为本文完整的配置文件内容：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<appender name="debug-out" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="${openfireHome}/logs/debug.log" />
		<param name="MaxFileSize" value="1024KB"/>
		<param name="MaxBackupIndex" value="5"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%d{yyyy.MM.dd HH:mm:ss} %c - %m%n" />
		</layout>
		<filter class="org.apache.log4j.varia.LevelRangeFilter">
			<param name="LevelMax" value="debug" />
			<param name="AcceptOnMatch" value="true" />
		</filter>
	</appender>

	<appender name="info-out" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="${openfireHome}/logs/info.log" />
		<param name="MaxFileSize" value="1024KB"/>
		<param name="MaxBackupIndex" value="5"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%d{yyyy.MM.dd HH:mm:ss} %c - %m%n" />
		</layout>
		<filter class="org.apache.log4j.varia.LevelRangeFilter">
			<param name="LevelMax" value="info" />
			<param name="LevelMin" value="info" />
			<param name="AcceptOnMatch" value="true" />
		</filter>
	</appender>

	<appender name="warn-out" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="${openfireHome}/logs/warn.log" />
		<param name="MaxFileSize" value="1024KB"/>
		<param name="MaxBackupIndex" value="5"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%d{yyyy.MM.dd HH:mm:ss} %c - %m%n" />
		</layout>
		<filter class="org.apache.log4j.varia.LevelRangeFilter">
			<param name="LevelMax" value="warn" />
			<param name="LevelMin" value="warn" />
			<param name="AcceptOnMatch" value="true" />
		</filter>
	</appender>
	
	<appender name="error-out" class="org.apache.log4j.RollingFileAppender">
		<param name="File" value="${openfireHome}/logs/error.log" />
		<param name="MaxFileSize" value="1024KB"/>
		<param name="MaxBackupIndex" value="5"/>
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%d{yyyy.MM.dd HH:mm:ss} %c - %m%n" />
		</layout>
		<filter class="org.apache.log4j.varia.LevelRangeFilter">
			<param name="LevelMin" value="error" />
			<param name="AcceptOnMatch" value="true" />
		</filter>
	</appender>

	<!-- OF-506: Jetty INFO messages are generally not useful. Ignore them by default. -->
	<logger name="org.eclipse.jetty">
		<level value="warn" />
	</logger>
	
    <!-- add begin -->  
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">  
        <layout class="org.apache.log4j.PatternLayout">  
            <param name="ConversionPattern" value="%-5p %d{yyyy-MM-dd HH:mm:ss}   %c{1}:%L - %m%n" />  
        </layout>  
    </appender>  
    <!-- add end --> 	
	
   	<root>
		<level value="debug" />
		<appender-ref ref="STDOUT" />
		<appender-ref ref="debug-out" />
		<appender-ref ref="info-out" />
		<appender-ref ref="warn-out" />
		<appender-ref ref="error-out" />
	</root>
	
</log4j:configuration>
           

3、输出日志

在java代码中使用如下代码获取一个日志对象，然后调用对应的日志方法即可。

private static final Logger Log = LoggerFactory.getLogger(test.class);
Log.debug("hello,world");