log4j2的JsonLayout测试

@(工程开发)

最近在开发通用的分布式日志采集器。碰到日志信息块的划分问题，尤其是碰到有异常堆栈的情况，需要做合并操作。当前我们的解决方案是使用日志块的起始时间来判断。有过萌生使用JsonLayout的想法，直接可以映射到ElasticSearch，方便创建索引，减少过多的字段切分。遂测试了log4j2的JsonLayout，网上资料还不多，简单的做下备忘。

log4j2相比于log4j版本1有了不少的变动，从maven的依赖看，使用的没有版本1的多。最主要的是log4j2不再支持log4j.properties的配置文件，主要使用log4j2.xml或者log4j2.json的配置方式。既然有xml，使用xml其实相对简单，毕竟有xsd文件，配置就可以免去太多的网上搜索。OK，废话少说，简单的xml配置可以如下：

<?xml version="1.0" encoding="UTF-8"?><!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL --><!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出 --><!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数 --><configuration status="INFO" monitorInterval="30"><properties>          <property name="log.fileNames">E:/webbase</property>      </properties> <!--先定义所有的appender --><appenders><!--这个输出控制台的配置 --><console name="Console" target="SYSTEM_OUT"><!--输出日志的格式 --><PatternLayout pattern="%l - %m%n" /><!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） --><ThresholdFilter level="info" onMatch="ACCEPT"onMismatch="DENY" /></console><!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用 --><File name="log" fileName="log/test.log" append="false"><PatternLayoutpattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n" /></File><!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 --><RollingFile name="RollingFileInfo" fileName="${log.fileNames}/logs/app/info.log"filePattern="${log.fileNames}/logs/app/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log"><JsonLayout/> <!--json输出 --><!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） --><ThresholdFilter level="info" onMatch="ACCEPT"onMismatch="DENY" /><PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n" /><Policies><TimeBasedTriggeringPolicy /><SizeBasedTriggeringPolicy size="100 MB" /></Policies></RollingFile><RollingFile name="RollingFileWarn" fileName="${log.fileNames}/logs/app/warn.log"filePattern="${log.fileNames}/logs/app/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log"><ThresholdFilter level="warn" onMatch="ACCEPT"onMismatch="DENY" /><PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n" /><Policies><TimeBasedTriggeringPolicy /><SizeBasedTriggeringPolicy size="100 MB" /></Policies><!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 --><DefaultRolloverStrategy max="20" /></RollingFile><RollingFile name="RollingFileError" fileName="${log.fileNames}/logs/app/error.log"filePattern="${log.fileNames}/logs/app/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log"><ThresholdFilter level="error" onMatch="ACCEPT"onMismatch="DENY" /><PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n" /><Policies><TimeBasedTriggeringPolicy /><SizeBasedTriggeringPolicy size="100 MB" /></Policies></RollingFile></appenders><!--然后定义logger，只有定义了logger并引入的appender，appender才会生效 --><loggers><!--过滤掉spring和mybatis的一些无用的DEBUG信息 --><logger name="org.springframework" level="INFO"></logger><logger name="org.mybatis" level="INFO"></logger><logger name="springfox.documentation" level="WARN"></logger><root level="all"><appender-ref ref="Console" /><appender-ref ref="RollingFileInfo" /><appender-ref ref="RollingFileWarn" /><appender-ref ref="RollingFileError" /></root></loggers></configuration>

简单的创建一个测试类：

package com.linjx.log4j.jsonpattern;import org.slf4j.Logger;import org.slf4j.LoggerFactory;/** * 测试JSON格式打印结果 * @author linjiexing * @Date 2016年8月13日 * @version 1.1.0 */public class JsonPatternTest {    static Logger logger = LoggerFactory.getLogger(JsonPatternTest.class);    public static void main(String[] args) {        logger.error("exception:[{}]", new RuntimeException("ao"));    }}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

我们测试下，具体JSON的输出结果内容：

{  "timeMillis" : 1472887418669,  "thread" : "main",  "level" : "ERROR",  "loggerName" : "com.linjx.log4j.jsonpattern.JsonPatternTest",  "message" : "exception:[{}]",  "thrown" : {    "commonElementCount" : 0,    "localizedMessage" : "ao",    "message" : "ao",    "name" : "java.lang.RuntimeException",    "extendedStackTrace" : [ {      "class" : "com.linjx.log4j.jsonpattern.JsonPatternTest",      "method" : "main",      "file" : "JsonPatternTest.java",      "line" : 19,      "exact" : true,      "location" : "classes/",      "version" : "?"    } ]  },  "endOfBatch" : false,  "loggerFqcn" : "org.apache.logging.slf4j.Log4jLogger",  "threadId" : 1,  "threadPriority" : 5}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

格式还是相对清晰的，如果使用ELK，采用这样的日志格式，相对就简单得多了。就是要研发能够适应，毕竟信息有点小分裂。

另外，提醒下使用者，使用JsonLayout是需要依赖Jackson包的，具体完整的pom.xml配置如下：

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <groupId>com.linjx.log4j</groupId>    <artifactId>jsonpattern</artifactId>    <version>1.0.0</version>    <properties>        <maven.compiler.source>1.8</maven.compiler.source>        <maven.compiler.target>1.8</maven.compiler.target>        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>        <maven.build.timestamp.format>yyyy-MM-dd HH:mm:ss</maven.build.timestamp.format>        <timestamp>${maven.build.timestamp}</timestamp>        <hibernate.version>4.3.10.Final</hibernate.version>        <spring.version>4.1.7.RELEASE</spring.version>        <log4j.version>2.6.2</log4j.version>    </properties>    <dependencies>        <dependency>            <groupId>org.apache.logging.log4j</groupId>            <artifactId>log4j-api</artifactId>            <version>${log4j.version}</version>        </dependency>        <dependency>            <groupId>org.apache.logging.log4j</groupId>            <artifactId>log4j-core</artifactId>            <version>${log4j.version}</version>        </dependency>        <dependency>            <groupId>org.apache.logging.log4j</groupId>            <artifactId>log4j-slf4j-impl</artifactId>            <version>${log4j.version}</version>        </dependency>        <!-- 使用jsonLayout必须依赖jackson -->        <dependency>            <groupId>com.fasterxml.jackson.core</groupId>            <artifactId>jackson-core</artifactId>            <version>2.7.4</version>        </dependency>        <dependency>            <groupId>com.fasterxml.jackson.core</groupId>            <artifactId>jackson-databind</artifactId>            <version>2.7.4</version>        </dependency>    </dependencies></project>

该文转载：http://blog.csdn.net/wendingzhulu/article/details/52423522