将自定义域添加到log4j json布局打破了spring日志结构

Question

我有一个使用Log4j2（带有Slf4j)的Spring Boot(2.2.6)应用程序。Log4j被配置为使用json布局，最后我希望在DataDog中获取日志。因此，'service name'作为JSON中的一个字段非常重要。

现在，根据log4j文档(https://logging.apache.org/log4j/2.x/manual/layouts.html#JSONLayout)，可以添加一个带有'KeyValuePair'标记的自定义字段，这样就可以工作了。不幸的是，这打破了Spring原木的正常结构。

log4j2.xml配置：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <Appenders>
        <!-- Write logs to stdout, JSON, one line per log event -->
        <Console name="Console" target="SYSTEM_OUT">
            <JSONLayout compact="true" eventEol="true" includeStacktrace="true" locationInfo="true"
                        stacktraceAsString="true" properties="true">
      <KeyValuePair key="serviceName" value="$${env:APPLICATION_NAME:-local}-sidecar"/> <!-- fine w/o this line -->
</JSONLayout>
        </Console>
    </Appenders>
    <Loggers>
        <Logger name="my.service" level="debug" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
        <Logger name="org.apache" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

不带自定义域得日志：

{
  "thread": "main",
  "level": "INFO",
  "loggerName": "com.nginxtrafficsidecar.ApplicationKt",
  "message": "Starting ApplicationKt on xxx with PID 17300 (C:\\Users\\Felix\\Documents\\code\\nginx-traffic-sidecar\\build\\classes\\kotlin\\main started by Felix in C:\\Users\\Felix\\Documents\\code\\nginx-traffic-sidecar)",
  "endOfBatch": false,
  "loggerFqcn": "org.apache.commons.logging.LogAdapter$Log4jLog",
  "threadId": 1,
  "instant": {
    "epochSecond": 1587975181,
    "nanoOfSecond": 331370300
  },
  "source": {
    "class": "org.springframework.boot.StartupInfoLogger",
    "method": "logStarting",
    "file": "StartupInfoLogger.java",
    "line": 55,
    "classLoaderName": "app"
  },
  "contextMap": {},
  "threadPriority": 5
}

带自定义域得日志：

{
  "logEvent": "Starting ApplicationKt on xxx with PID 9732 (C:\\Users\\Felix\\Documents\\code\\nginx-traffic-sidecar\\build\\classes\\kotlin\\main started by Felix in C:\\Users\\Felix\\Documents\\code\\nginx-traffic-sidecar)",
  "serviceName": "local-sidecar"
}

Spring docu提到了如何使用logback，而不是log4j(https://docs.Spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-custom-log-configuration，章节末尾）

Answer 1

• 下载Jackson Annotations并导入它，因为JSONLayout使用Jackson Annotations内部代码。
  • 在我的示例中，下载并导入这些

  jackson-annotations-2.10.3.jar
  jackson-core-2.10.3.jar
  jackson-databind-2.10.3.jar
  

  <JsonLayout>
    <KeyValuePair key="testKey" value="testValue"/>
  </JsonLayout>
  

  将key和value替换为要使用的内容。在我的示例中，key是“testkey”，value是“testvalue”

  它是我的完整示例代码和xml配置信息。代码

  import org.apache.logging.log4j.LogManager;
  import org.apache.logging.log4j.Logger;
  import org.apache.logging.log4j.ThreadContext;
  
  public class LogTest{
      private static final Logger logger = LogManager.getLogger(LogTest.class.getName());
  
  
      public static void main(String[] args) {
          ThreadContext.put("logFileName", "testFile1" );
          logger.info("log printed! - testFile1");
  
          ThreadContext.put("logFileName", "testFile2" );
          logger.info("log printed! - testFile2");
  
          ThreadContext.remove("logFileName");
      }
  
  }
  

  <?xml version="1.0" encoding="UTF-8"?>
  <Configuration status="WARN">
      <Appenders>
          <Routing name="RoutingAppender">
              <Routes pattern="${ctx:logFileName}">
                  <Route>
                      <RollingFile name="Rolling-${ctx:logFileName}"
                                   fileName="./logs/${ctx:logFileName}.log"
                                   filePattern="./logs/${ctx:logFileName}.%i.log.gz">
                          <JsonLayout>
                              <KeyValuePair key="testKey" value="testValue"/>
                          </JsonLayout>
                          <SizeBasedTriggeringPolicy size="512" />
                      </RollingFile>
                  </Route>
              </Routes>
          </Routing>
      </Appenders>
  
      <Loggers>
          <Root level="all">
              <AppenderRef ref="RoutingAppender" />
          </Root>
      </Loggers>
  </Configuration>
  

  {
    "instant" : {
      "epochSecond" : 1588590944,
      "nanoOfSecond" : 469000000
    },
    "thread" : "main",
    "level" : "INFO",
    "loggerName" : "com.test.LogTest",
    "message" : "log printed! - testFile2",
    "endOfBatch" : false,
    "loggerFqcn" : "org.apache.logging.log4j.spi.AbstractLogger",
    "threadId" : 1,
    "threadPriority" : 5,
    "testKey" : "testValue"
  }