Kotlin SpringBoot中SLF4J(基于Log4j2)结构化日志实现咨询

因为你的项目已经基于SLF4J适配Log4j2，完全可以借助Log4j2自带的JSON布局功能实现结构化日志，不需要升级SLF4J 1.7.30版本。以下是具体操作步骤：

1. 补充必要依赖 #

确保项目包含Log4j2的JSON布局依赖（若未添加）：

Maven配置 #

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-layout-template-json</artifactId>
    <version>2.17.1</version> <!-- 选择与当前Log4j2匹配的版本 -->
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.17.1</version> <!-- 版本适配SLF4J 1.7.30 -->
</dependency>

Gradle（Kotlin DSL）配置 #

implementation("org.apache.logging.log4j:log4j-layout-template-json:2.17.1")
implementation("org.apache.logging.log4j:log4j-slf4j-impl:2.17.1")

2. 配置Log4j2输出JSON格式 #

修改log4j2.xml或log4j2.yml配置文件，使用JsonTemplateLayout（推荐，适配Splunk解析需求）：

XML配置示例（log4j2.xml） #

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <!-- 控制台输出示例，也可配置文件输出等其他Appender -->
        <Console name="Console" target="SYSTEM_OUT">
            <!-- 使用Elastic Common Schema模板，Splunk可直接解析 -->
            <JsonTemplateLayout eventTemplateUri="classpath:EcsLayout.json" />
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console" />
        </Root>
    </Loggers>
</Configuration>

YAML配置示例（log4j2.yml） #

Configuration:
  status: warn
  Appenders:
    Console:
      name: Console
      target: SYSTEM_OUT
      JsonTemplateLayout:
        eventTemplateUri: classpath:EcsLayout.json
  Loggers:
    Root:
      level: info
      AppenderRef:
        ref: Console

若需要更基础的JSON格式，可替换为JsonLayout：

<JsonLayout complete="true" compact="false" includeThreadContext="true" />

includeThreadContext="true"会自动把MDC中的键值对加入JSON输出。

3. 在代码中添加结构化键值对 #

由于SLF4J 1.7没有Fluent API，推荐用**MDC（ThreadContext）**传递结构化字段，这是最简洁的方式：

Kotlin代码示例 #

import org.slf4j.LoggerFactory
import org.slf4j.MDC

val log = LoggerFactory.getLogger(YourService::class.java)

// 封装工具函数，避免手动清理MDC导致内存泄漏
fun withMDC(vararg pairs: Pair<String, String>, block: () -> Unit) {
    pairs.forEach { MDC.put(it.first, it.second) }
    try {
        block()
    } finally {
        pairs.forEach { MDC.remove(it.first) }
    }
}

// 使用示例
fun handleUserLogin(userId: String, ip: String) {
    withMDC("userId" to userId, "ipAddress" to ip, "action" to "login") {
        log.info("User login attempt succeeded")
    }
}

这段代码会输出包含userId、ipAddress、action字段的JSON日志，Splunk可直接基于这些字段过滤。

若需要在日志消息中添加动态参数，仍可使用SLF4J的参数化日志：

log.info("User {} failed to access resource {}", userId, resourcePath)

这些参数会被包含在JSON的message字段中，也可通过自定义模板提取为单独字段。

4. 验证输出 #

启动项目后，日志会输出类似以下的JSON格式：

{
  "@timestamp": "2024-05-20T12:34:56.789Z",
  "log.level": "INFO",
  "message": "User login attempt succeeded",
  "userId": "12345",
  "ipAddress": "192.168.1.100",
  "action": "login",
  "process.thread.name": "http-nio-8080-exec-1",
  "log.logger": "com.example.YourService"
}

Splunk可直接识别这些字段并进行过滤、分析。

内容的提问来源于stack exchange，提问作者Mauricio Avendaño