log4j自定义Appender

时间 2019-11-18

原文原文链接

一、背景虽然log4j很强大，能够将日志输出到文件、DB、ES等。可是有时候确不免彻底适合本身，此时咱们就须要自定义Appender，使日志输出到指定的位置上。java

本文，将经过两个例子说明自定义APPender，一个是将日志写入文件中，另外一个是将日志发送到远程Thrift服务中。git

本文代码详见：https://github.com/hawkingfoo/log-demogithub

二、自定义文件Appender 2.1 定义文件Appender 先上代码：spring

@Plugin(name = "FileAppender", category = "Core", elementType = "appender", printObject = true) public class FileAppender extends AbstractAppender { private String fileName;mybatis

/* 构造函数 */
public FileAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, String fileName) {
    super(name, filter, layout, ignoreExceptions);
    this.fileName = fileName;
}

[@Override](https://my.oschina.net/u/1162528)
public void append(LogEvent event) {
    final byte[] bytes = getLayout().toByteArray(event);
    writerFile(bytes);

}

/*  接收配置文件中的参数 */
@PluginFactory
public static FileAppender createAppender(@PluginAttribute("name") String name,
                                          @PluginAttribute("fileName") String fileName,
                                          @PluginElement("Filter") final Filter filter,
                                          @PluginElement("Layout") Layout<? extends Serializable> layout,
                                          @PluginAttribute("ignoreExceptions") boolean ignoreExceptions) {
    if (name == null) {
        LOGGER.error("no name defined in conf.");
        return null;
    }
    if (layout == null) {
        layout = PatternLayout.createDefaultLayout();
    }
    // 建立文件
    if (!createFile(fileName)) {
        return null;
    }
    return new FileAppender(name, filter, layout, ignoreExceptions, fileName);
}

private static boolean createFile(String fileName) {
    Path filePath = Paths.get(fileName);
    try {
        // 每次都从新写文件，不追加
        if (Files.exists(filePath)) {
            Files.delete(filePath);
        }
        Files.createFile(filePath);
    } catch (IOException e) {
        LOGGER.error("create file exception", e);
        return false;
    }
    return true;
}

private void writerFile(byte[] log) {
    try {
        Files.write(Paths.get(fileName), log, StandardOpenOption.APPEND);
    } catch (IOException e) {
        LOGGER.error("write file exception", e);
    }
}

} 上面代码有几个须要注意的地方：app

@Plugin..注解：这个注解，是为了在以后配置log4j2.xml时，指定的Appender Tag。构造函数：除了使用父类的之外，也能够增长一些本身的配置。重写append()方法：这里面须要实现具体的逻辑，日志的去向。 createAppender()方法：主要是接收log4j2.xml中的配置项。 2.2 添加log4j2.xml配置ide

<?xml version="1.0" encoding="UTF-8"?>函数

<configuration status="INFO" monitorInterval="30"> <appenders>  <console name="Console" target="SYSTEM_OUT">  <PatternLayout pattern="%highlight{[ %p ] [%-d{yyyy-MM-dd HH:mm:ss}] [%l] %m%n}"/> </console>测试

<!-- 这个就是自定义的Appender -->
    <FileAppender name="File" fileName="log.log">
        <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] [%-5p] {%F:%L} - %m%n" />
    </FileAppender>

</appenders>

<loggers>
    <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
    <logger name="org.springframework" level="INFO"></logger>
    <logger name="org.mybatis" level="INFO"></logger>
    <root level="all">
        <appender-ref ref="Console"/>
        <appender-ref ref="File"/>
    </root>
</loggers>

</configuration> 备注：this

上面的log配置，一共配了2个输出。一个是终端输出，一个是采用自定义的FileAppender输出到文件中。 <FileAppender>标签要与自定义Appender中的类注解保持一致。 2.3 测试 public class TestLogFile { private static final Logger logger = LogManager.getLogger(TestLogFile.class);

public static void main(String[] args) {
    logger.info("1");
    logger.info("2");
    logger.info("3");
}

} 日志输出日志输出能够看到，日志一共输出了2份，一份到终端中，一份到log.log中（具体的文件路径可在log4j2.xml中配置）。

三、自定义Thrift Appender 上一节，主要是日志的文件输出。有时咱们须要将日志发送给日志收集服务，常见的方法能够写一个日志收集Agent，收集日志；或者将日志输出方当成客户端直接发送到远程。

下文，经过自定义Appender的方式，将日志输出到远程的RPC服务中。

3.1 Thrift RPC服务假设如今有一个Thrift RPC服务，实时接收日志消息。它的定义是下面的样子：

namespace java thrift

service LogServer { string getLogRes(1:string log); } 服务很简单，入参是log，返回值是String。 Thrift相关知识能够查看，Thrift RPC服务10分钟上手。

3.2 定义ThriftAppender @Plugin(name = "ThriftAppender", category = "Core", elementType = "appender", printObject = true) public class ThriftAppender extends AbstractAppender {

private LogServer.Client client;
private TTransport transport;

/* 构造函数 */
public ThriftAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, String host) {
    super(name, filter, layout, ignoreExceptions);
    // 建立客户端
    createThriftClient(host);
}

@Override
public void append(LogEvent event) {
    final byte[] bytes = getLayout().toByteArray(event);
    try {
        String response = client.getLogRes(new String(bytes));
        System.out.println(response);
    } catch (TException e) {
        e.printStackTrace();
    }
}

/*  接收配置文件中的参数 */
@PluginFactory
public static ThriftAppender createAppender(@PluginAttribute("name") String name,
                                          @PluginAttribute("host") String host,
                                          @PluginElement("Filter") final Filter filter,
                                          @PluginElement("Layout") Layout<? extends Serializable> layout,
                                          @PluginAttribute("ignoreExceptions") boolean ignoreExceptions) {
    if (name == null) {
        LOGGER.error("no name defined in conf.");
        return null;
    }
    if (layout == null) {
        layout = PatternLayout.createDefaultLayout();
    }
    return new ThriftAppender(name, filter, layout, ignoreExceptions, host);
}

@Override
public void stop() {
    if (transport != null) {
        transport.close();
    }
}

private void createThriftClient(String host) {
    try {
        transport = new TFramedTransport(new TSocket(host, 9000));
        transport.open();
        TProtocol protocol = new TBinaryProtocol(transport);
        client = new LogServer.Client(protocol);
        LOGGER.info("create client success");
    } catch (Exception e) {
        LOGGER.error("create file exception", e);
    }
}

} 备注：除了和文件Appender相同的外，这里须要注意两个地方。一个是Thrift Client的建立，另外一个Thrift发送log。具体的发送逻辑，在append()方法中实现。

3.3 添加log4j2.xml配置

<?xml version="1.0" encoding="UTF-8"?>

<!-- 这个就是自定义的Appender -->
    <ThriftAppender name="Thrift" host="127.0.0.1">
        <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] [%-5p] {%F:%L} - %m%n" />
    </ThriftAppender>
</appenders>

<loggers>
    <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
    <logger name="org.springframework" level="INFO"></logger>
    <logger name="org.mybatis" level="INFO"></logger>
    <root level="all">
        <appender-ref ref="Console"/>
        <appender-ref ref="Thrift"/>

    </root>
</loggers>

</configuration> 这里一样是定义了两个输出路径，一个是终端，一个是Thrift服务。

3.4 测试 public class TestThriftFile { private static final Logger logger = LogManager.getLogger(TestThriftFile.class);

public static void main(String[] args) {
    logger.info("a");
    logger.info("b");
    logger.info("c");
}

} Server端 Client端能够看出，Server端成功接收到了log。