解决Log4j2多Appender写入同一文件导致日志重复的问题

本文旨在解决log4j2配置中，多个appender意外写入同一日志文件导致日志重复的问题。核心在于理解log4j2的工作机制，并强调为每个独立的appender配置唯一的文件路径，从而确保日志内容的准确性和独立性，避免不必要的重复记录。

Log4j2 Appender与日志重复现象解析

在Log4j2日志框架中，Appender（日志输出器）是负责将日志事件写入到具体目的地的核心组件，例如控制台、文件、数据库或远程服务器等。开发者通常会配置一个或多个Appender来满足不同的日志记录需求。然而，一个常见的配置误区是，当多个RollingFile或其他文件类型的Appender被配置为写入同一个物理文件时，可能会导致日志内容出现重复。

考虑以下Log4j2配置片段，它展示了两个RollingFile Appender (service1 和 service2) 都被配置为写入 test.log 文件，并且这两个Appender都被Root Logger引用：

<Configuration status="WARN">
    <Appenders>
        <RollingFile name="service1" fileName="${sys:catalina.base}/test.log" 
                     filePattern="${sys:catalina.base}/test-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <SizeBasedTriggeringPolicy size="100MB" />
            </Policies>
            <DefaultRolloverStrategy max="10" />
        </RollingFile>

        <RollingFile name="service2" fileName="${sys:catalina.base}/test.log" 
                     filePattern="${sys:catalina.base}/test-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <SizeBasedTriggeringPolicy size="100MB" />
            </Policies>
            <DefaultRolloverStrategy max="10" />
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="service1"/>
            <AppenderRef ref="service2" />
        </Root>
    </Loggers>
</Configuration>

当应用程序的日志事件被Root Logger捕获时，它会将该事件传递给所有引用的Appender。在本例中，一个日志事件会首先被service1 Appender处理并写入 test.log，然后又被service2 Appender处理并再次写入 test.log。由于两者都指向同一个文件，结果就是每个日志事件都会在 test.log 中出现两次，造成日志冗余，例如输出会是：

Debugging data1
Debugging data1
Debugging data2
Debugging data2

解决方案：为每个Appender配置独立的日志文件

解决此问题的关键在于确保每个Appender写入其独立的日志文件。Log4j2的Appender设计初衷是独立地处理日志输出流。如果希望有不同的日志处理策略（例如，不同的滚动策略、不同的日志级别过滤等），那么它们通常也应该对应不同的物理输出目标。

Ghiblio

专业AI吉卜力风格转换平台，将生活照变身吉卜力风格照

157

查看详情

最直接的修复方法是修改每个RollingFile Appender的 fileName 属性，使其指向不同的文件路径。同时，为了避免滚动文件也冲突，filePattern也应进行相应的调整。

<Configuration status="WARN">
    <Appenders>
        <RollingFile name="service1" fileName="${sys:catalina.base}/test_service1.log" 
                     filePattern="${sys:catalina.base}/test_service1-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <SizeBasedTriggeringPolicy size="100MB" />
            </Policies>
            <DefaultRolloverStrategy max="10" />
        </RollingFile>

        <RollingFile name="service2" fileName="${sys:catalina.base}/test_service2.log" 
                     filePattern="${sys:catalina.base}/test_service2-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <SizeBasedTriggeringPolicy size="100MB" />
            </Policies>
            <DefaultRolloverStrategy max="10" />
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="service1"/>
            <AppenderRef ref="service2" />
        </Root>
    </Loggers>
</Configuration>

通过上述修改，service1 Appender会将日志写入 test_service1.log，而 service2 Appender则会写入 test_service2.log。这样，即使Root Logger同时引用了这两个Appender，它们也会将日志事件分别写入不同的文件，从而避免了日志重复的问题。

Log4j2配置最佳实践与注意事项

1. 明确Appender职责： 每个Appender都应有其明确的职责和目标。如果两个Appender的配置（如滚动策略、布局模式）完全相同，并且它们都应该处理相同的日志事件，那么通常只需要一个Appender。如果确实需要不同的处理（例如，一个Appender用于审计日志，另一个用于调试日志），则必须确保输出目标不同。
2. AppenderRef的正确使用： 当一个Logger（包括Root Logger）引用了多个AppenderRef时，每个Appender都会独立地处理日志事件。如果这些Appender指向相同的输出目标，就会导致重复。
3. Logger层级与Additivity： 对于更复杂的日志管理场景，可以利用Log4j2的Logger层级结构和additivity属性。例如，可以为特定的包或类定义独立的Logger，并为其指定特定的Appender，同时设置additivity="false"以防止日志事件传递给父Logger（包括Root Logger）及其Appender，从而实现更精细的日志控制。
   • 示例：为特定服务配置独立日志

     <Configuration status="WARN">
         <Appenders>
             <RollingFile name="ServiceAFile" fileName="${sys:catalina.base}/serviceA.log" 
                          filePattern="${sys:catalina.base}/serviceA-%d{yyyy-MM-dd}-%i.log">
                 <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
                 <Policies><SizeBasedTriggeringPolicy size="100MB" /></Policies>
                 <DefaultRolloverStrategy max="10" />
             </RollingFile>
             <RollingFile name="ServiceBFile" fileName="${sys:catalina.base}/serviceB.log" 
                          filePattern="${sys:catalina.base}/serviceB-%d{yyyy-MM-dd}-%i.log">
                 <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
                 <Policies><SizeBasedTriggeringPolicy size="100MB" /></Policies>
                 <DefaultRolloverStrategy max="10" />
             </RollingFile>
             <Console name="Console" target="SYSTEM_OUT">
                 <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
             </Console>
         </Appenders>
         <Loggers>
             <!-- com.example.serviceA 包下的日志只由 ServiceAFile Appender处理，不传递给父Logger -->
             <Logger name="com.example.serviceA" level="info" additivity="false">
                 <AppenderRef ref="ServiceAFile"/> 
             </Logger>
             <!-- com.example.serviceB 包下的日志只由 ServiceBFile Appender处理，不传递给父Logger -->
             <Logger name="com.example.serviceB" level="info" additivity="false">
                 <

     登录后复制

以上就是解决Log4j2多Appender写入同一文件导致日志重复的问题的详细内容，更多请关注php中文网其它相关文章！