Log4j指定配置文件的日志格式仅在部分环境生效问题求助

我们的应用通过Log4j控制日志行为，在Log4j配置XML的Configuration.Appenders.RollingFile.StructuredLayout节点下用Field元素定义日志行格式。目前遇到的问题是：日志格式仅在生产环境生效，预发布环境无格式化效果。

环境启动命令（预发布与生产一致） #

# 预发布环境启动命令
java -Dlog4j.configurationFile=/opt/ais/config/log4j2.xml -jar myApp.jar

# 生产环境启动命令
java -Dlog4j.configurationFile=/opt/ais/config/log4j2.xml -jar myApp.jar

日志效果对比 #

预发布环境（未生效） #

> cat /opt/ais/logs/splunk/myApp/host-0-443.log
test log message

生产环境（正常生效） #

> cat /opt/ais/logs/splunk/myApp/host-0-443.log
timestamp="2023-05-03 07:13:15,461",level="INFO",thread="pool-2-thread-1",message="test log message",logger="MessageProcessor",appName="myApp",instanceNum="300",dataCenter="MR",partition="MR",buildVersion="1.0.0"

完整Log4j配置XML #

<?xml version="1.0" encoding="UTF-8"?>
<Configuration packages="com.apple.jvm.commons.logging.structured">
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <StructuredLayout/>
    </Console>
    <RollingFile name="RollingFile"
                 fileName="/opt/ais/logs/splunk/${sys:ISApplicationName}/${sys:ISHostId}-${sys:ISInstanceId}-${sys:WOPort}.log"
                 filePattern="/opt/ais/logs/${sys:ISApplicationName}/${sys:ISHostId}-${sys:ISInstanceId}-${sys:WOPort}.%i.log">
      <StructuredLayout serializer="com.mycompany.jvm.commons.logging.structured.kv.KeyValueSerializer" fieldSeparator="," timeZoneId="America/Los_Angeles">
        <Field name="timestamp" pattern="%date{yyyy-MM-dd HH:mm:ss,SSS}{America/Los_Angeles}"/>
        <Basic exclude="timestamp"/>
        <Throwable name="exception"/>
        <Field name="appName" value="${sys:ISApplicationName}"/>
        <Field name="instanceNum" value="${sys:ISInstanceId}"/>
        <Field name="dataCenter" value="${sys:ISDataCenter}"/>
        <Field name="partition" value="${sys:partition}"/>
        <Field name="buildVersion" value="${sys:build.version}"/>
      </StructuredLayout>
      <Policies>
        <SizeBasedTriggeringPolicy size="500 MB"/>
      </Policies>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Root level="info">
      <AppenderRef ref="RollingFile"/>
      <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</Configuration>

排查方向 #

• 类路径依赖差异：预发布环境可能缺失StructuredLayout或KeyValueSerializer对应的依赖包。对比生产环境的依赖清单，检查预发布环境是否存在com.apple.jvm.commons.logging.structured和com.mycompany.jvm.commons.logging.structured.kv.KeyValueSerializer相关的jar包，版本是否一致。
• 配置加载优先级问题：Log4j可能在预发布环境加载了其他默认配置。启动时添加-Dlog4j.debug=true参数，查看日志输出中实际加载的配置文件路径；同时检查应用目录、类路径下是否存在log4j2.properties、log4j.xml等优先级更高的配置文件。
• 系统变量缺失：配置中使用了${sys:ISApplicationName}等系统变量，预发布环境可能未正确设置。通过-Dlog4j.debug=true查看变量解析情况，对比生产环境的系统变量定义，确保所有用到的变量都已配置。
• 权限问题：检查预发布环境中/opt/ais/config/log4j2.xml的文件权限，确保运行应用的用户拥有读取权限；查看应用启动日志，是否存在配置文件读取失败的报错。
• 版本兼容性：对比生产和预发布环境的Log4j核心jar版本，确认版本一致；检查自定义StructuredLayout是否与当前Log4j版本存在兼容性问题。

内容的提问来源于stack exchange，提问作者James Wierzba