源文章：structlog4j介绍

结构化日志对于日志的收集的作用挺大的，根据自身的业务场景，基于SLF4J实现了structlog4j。

相关引用

Gradle

// 基础包

compile 'tech.ibit:structlog4j-api:latest'

// 支持json, yaml格式等扩展

compile 'tech.ibit:structlog4j-extend:latest'

Maven

<!--基础包-->

<dependency>

    <groupId>tech.ibit</groupId>

    <artifactId>structlog4j-api</artifactId>

    <version>latest</version>

</dependency>

<!--扩展包-->

<dependency>

    <groupId>tech.ibit</groupId>

    <artifactId>structlog4j-extend</artifactId>

    <version>latest</version>

</dependency>

概述

structlog4j的核心思想就是将日志已key-value的方式呈现，方便日期切分。

日志保留字段

_message: 消息内容

_errorMessage: 异常信息

_stackTrace: 异常stack trace信息

引入logger

import tech.ibit.structlog4j.Logger;

import tech.ibit.structlog4j.StructLoggerFactory;

private static final Logger log = StructLoggerFactory.getLogger(Test.class);

字符串处理

业务需要，将日志单行输入，所以对以下字符进行了处理, ":"前原字符串，":" 后的是处理后的字符

\t: \\t

\r: \\r

\n: \\n

默认日志格式(key-value)

_message=Something error!&user=ibit-tech_errorMessage=Test Exception

说明

  • 默认方式引入structlog4j-api即可
  • key-value的方式通过&进行分割，将&转为'%26'

json日志格式

{"_message":"Something error!","user":"ibit-tech","_errorMessage":"Test Exception"}

修改全局formatter方法：

方法1（java代码）：

StructLog4J.setFormatter(JsonFormatter.getInstance());

方法2（classpath:/structlog4j.properties)：

formatter=tech.ibit.structlog4j.extend.JsonFormatter#getInstance

说明

  • 需要引入structlog4j-extend
  • "#"后面为获取实例方法

yaml日志格式

hostname: localhost\nip: 127.0.0.1

修改全局formatter方法：

方法1（java代码）：

StructLog4J.setFormatter(YamlFormatter.getInstance());

方法2（classpath:/structlog4j.properties)：

formatter=tech.ibit.structlog4j.extend.YamlFormatter#getInstance

说明

  • 需要引入structlog4j-extend
  • "\n"：表示换行符号，读取到日志之后，需要将"\n"转为"\n"才能正确显示
  • "#"后面为获取实例方法

自定义日志格式

实现tech.ibit.structlog4j.Formatter#format方法即可

tech.ibit.structlog4j.Formatter {

    /**

     * 格式化（待实现）

     *

     * @param kvMap 兼职map

     * @return 格式化后的文本

     */

    String format(Map<String, ?> kvMap);

}

异常信息处理

  • 默认方式，StructLog4J.isTransStackTrace() == true, 日志中会出现_errorMessage和_stackTrace字段，_stackTrace进行了转义，单行显示
  • 当StructLog4J.isTransStackTrace() == false, 日志中只出现_errorMessage，然后之后就将异常信息在接下来的日志打印出来（多行）

eg:

# 单行打印stackTrace

_message=Something error&user=ibit-tech&_errorMessage=Test Exception&_stackTrace=java.lang.RuntimeException: Test Exception\n\tat tech.ibit.demo.structlog4j.Demo.main(Demo.java:32)\n

# 多行打印stackTrace

_message=Something error&user=ibit-tech&_errorMessage=Test Exception

java.lang.RuntimeException: Test Exception

	at tech.ibit.demo.structlog4j.Demo.main(Demo.java:33)

修改全局transStackTrace方法：

方法1（java代码）：

StructLog4J.setTransStackTrace(true|false);

方法2（classpath:/structlog4j.properties)：

transStackTrace=true|false

structlog4j.properties说明：

# 指定formatter 创建方式（工厂方法）

formatter=tech.ibit.structlog4j.extend.JsonFormatter#getInstance

# 指定异常的stackTrace日志是否需要转化

transStackTrace=true

用法

_message说明(以error为例子)

Logger存在一下方法支持error级别日志

/**

 * ERROR日志

 *

 * @param message 消息

 * @param params  参数

 */

void error(String message, Object... params);

/**

 * ERROR日志

 *

 * @param messages 消息片段

 * @param params   参数

 */

void error(Object[] messages, Object... params);

其中message和messages的区别在于，messages支持传入占位符，eg:

logger.error("Something error, id: 12, username: ibit-tech");

等价于:

logger.error(new Object[] {"Something error, id: {}, username: {}", 12, "ibit-tech"});

使用key-value的方式

log.error("Something error", "user", "ibit-tech", "age", 100);

实现ToLog对key-value进行包装

log.error("Something error", (ToLog) () -> new Object[] {"user", "ibit-tech", "age", 101});

异常处理

log.error("Something error", "user", "ibit-tech", "age", 100, new RuntimeException("Test Exception"));

混合使用

log.error("Something error", (ToLog) () -> new Object[] {"user", "ibit-tech"}, "age", 101);

log.error("Something error", (ToLog) () -> new Object[] {"user", "ibit-tech"}, "age", 101, (ToLog) () -> new Object[] {"city", "sz"}, new RuntimeException("Test Exception"));

POJO实现MapToLog，toLog()会返回POJO中所有字段

@Test

public void toLog() {

    User user = new User("ibit-tech", 21);

    Assert.assertEquals("[name, ibit-tech, age, 21]", Arrays.asList(user.toLog()).toString());

}

@Value

public class User implements MapToLog {

    private String name;

    private int age;

}

说明

  • 需要引入structlog4j-extend

License

Apache License 2.0

最新文章

  1. ng-table 简单实例
  2. gulp使用
  3. [UCSD白板题] Compute the Edit Distance Between Two Strings
  4. 1644 免费馅饼 题解（c++）（S.B.S.）
  5. [设计模式] .NET设计模式笔记 - 有多少种设计模式
  6. jexus 配置 学习
  7. 网上图书商城项目学习笔记-011Book模块查询(分页)
  8. Linux Kernel ‘exitcode_proc_write()’函数本地缓冲区溢出漏洞
  9. hdu 1010 回溯加奇偶性剪枝
  10. Python内置函数(22)——list
  11. 【转载】Java性能优化之JVM GC（垃圾回收机制）
  12. ios同步线程(dispatch_sync)保证代码在主线程中执行
  13. Jmeter(三十五)_分布式
  14. ionic编译安卓App
  15. Java知多少（82）标签、按钮和按钮事件简介
  16. AlphaRacks 2018年黑五 VPS $3.99/年
  17. Python 类方法
  18. J - FatMouse&#39;s Speed
  19. 利用arcgis处理遥感栅格数据，得到省平均值数据
  20. bzoj1876 SuperGCD

热门文章

  1. Redis（八）：zset/zadd/zrange/zrembyscore 命令源码解析
  2. 一步一步安装配置Ceph分布式存储集群
  3. LeetCode 677. Map Sum Pairs 键值映射(C++/Java)
  4. 06讲案例篇：系统的CPU使用率很高，但为啥却找不到高CPU的应用
  5. 如何在国内下载Eclipse及其插件
  6. C语言的体系结构--main函数存在的必然性（听杨力祥老师的课）
  7. 林大妈的JavaScript进阶知识（二）：JS异步行为
  8. python学习（3）关于交互输入及字符串拼接
  9. Apache Tomcat文件包含漏洞紧急修复
  10. Generalized end-to-end loss for speaker verification