最好用的 Kafka Json Logger Java客户端，赶紧尝试一下

最好用的 Kafka Json Logger Java客户端。

slf4j4json

最好用的 Kafka Json Logger 库；不尝试一下可惜了！

Description

一款为 Kafka 提供的 json logger 客户端，支持将 json 格式的 log 输出到 kafka、文件、控制台。

支持 slf4j 的全部功能。

比 KafkaLog4jAppender 更好用，可配置性更好。

支持 close logger， 在程序关闭之前 flush log to kafka。

支持链式编程模式，方便用户使用。

maven dependency

1. 添加repository

<repositories>
    <repositories>
         <repository>
             <id>release</id>
             <url>https://raw.github.com/joyang1/slf4j4json/mvn-repo/</url>
             <snapshots>
                 <enabled>true</enabled>
                 <updatePolicy>always</updatePolicy>
             </snapshots>
         </repository>
     </repositories>
</repositories>

1. 添加dependency

<dependency>
    <groupId>cn.tommyyang</groupId>
    <artifactId>slf4j4json</artifactId>
    <version>1.4.0</version>
</dependency>

使用

需要配置log4j.properties

因为该 jar 包同样是依赖于 slf4j， 所以按 log4j 配置 log4j.properties 即可正常使用。

log4j.properties 的详细配置说明请参考log4j 配置说明

log4j.rootLogger=DEBUG,console
#输出日志到控制台
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=all
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%-d{yyyy-MM-dd HH\:mm\:ss} [%c\:%L]-[%p] %m%n

slf4j4json使用

1. 直接打印
   
   跟 slf4j 类似，不过该库提供链式编程方式，便于用户使用。

//通过LoggerFactory获取一个logger
final static Logger logger = LoggerFactory.getLogger(Test.class);
//打印必须调用log()方法
logger.info().field("key1", "value1").intField("key2", 1).log();
logger.warn().field("key1", "value1").intField("key2", 1).log();
logger.debug().strField("key1", "value1").longField("key2", 1L).log();
logger.trace().strField("key1", "value1").intField("key2", 1).log();
logger.error().strField("key1", "value1").intField("key2", 1).log();

1. 比如有一些键值对要重复赋值,使用getLogger方法，实例如下

JsonLogger jsonLogger = logger.info().strField("appname", "app").getLogger();
jsonLogger.strField("msg","infotest1").intField("port", 2).log();
jsonLogger.field("msg","infotest2").longField("long", 23L).log();

1. 1.4.0更新, 只提供getLogger方法

配置了 LogConfig 则打印 log 到 kafka，否则打印 log 到 file；

如果打印 log 到 file 文件或者控制台，则需要配置 log4j.properties，具体如何配置见使用；

如果只用打印 log 到 kafka，则不用配置 log4j.properties。

LogConfig conf = new LogConfig("Vinci", LogLevel.INFO, "localhost:9092", "admin-app-log");
LoggerFactory.openKafkaLogger(conf);
Logger logger  = LoggerFactory.getLogger();
logger.info().strField("test", "test-info").log();
logger.error().strField("test", "test-error").log();
logger.warn().strField("test", "test-warn").log();
logger.debug().strField("test", "test-debug").log();

输出

{"key1":"value1","key2":1,"index":"server-end-log","host":"DESKTOP-2B1VG6J","level":"info","time":1535021174}

version

• 1.0版本

  • 实现 JsonLog For Java 的基本功能

  • 使用 KafkaLog4jAppender 打印 log 到 Kafka

• 1.1版本

  • 修复JsonLogger jsonLogger = logger.info().strField("appname", "app").getLogger(); 出现重复内容的bug

• 1.2版本

  • 去掉log中自带的index键值对

  • repository修改

    
    <repositories>
        <repository>
            <id>release</id>
            <url>https://raw.github.com/joyang1/slf4j4json/mvn-repo/</url>
            <snapshots>
                <enabled>true</enabled>
                <updatePolicy>always</updatePolicy>
            </snapshots>
        </repository>
    </repositories>
    

• 1.3.0版本

  • 添加kafka logger的实现，批量打印log到kafka

  • 10s或者5m flush一次

• 1.4.0版本

  • 优化logger实现

欢迎 fork 和 star

Github地址：slf4j4json