如何使用Log4j2 xml重写appender在登录文件之前修改LogEvent

Question

我想在我的log4j2.xml文件中使用Rewrite appender，以便在登录之前我可以修改日志。我没有得到谷歌的帮助。根据log4j2文件，Rewrite是一个具有重写方法的接口，MapRewritePolicy是实现类，当我运行它时，我能够看到我的web3.log文件生成但没有看到日志内容的任何修改。我在项目中看到了MapRewritePolicy源代码并将MapRewritePolicyImpl.java创建为本地实现类，并将一些System.out用于查看代码流是否从log4j2.xml文件进入此类。我已经修改了我的log4j2.xml以使用MapRewritePolicyImpl.java但是代码流没有进入我的MapRewritePolicyImpl.java类。

<Rewrite name="rewrite" >
            <Appender-Ref ref="web3" />
             <MapRewritePolicyImpl">
                <KeyValuePair key="creditCard" value="new12345"/>
            </MapRewritePolicyImpl> 
        </Rewrite>



    <Configuration monitorInterval="5" status="debug" strict="true">
        <Appenders>
            <RollingFile name="web3" fileName="../logs/web3.log" 
                filePattern="${sys:catalina.home}/logs/$${date:yyyy-MM-dd}/web3-%d{yyyy-MM-dd}-%i.log.gz">
                <PatternLayout
                    pattern="%d{dd/MM/yyyy HH:mm:ss,SSS} [%X{cartID}] [%X{sessionId}] [%p] [%t] [%c] (%F:%L)  - %m%n" />
                <Policies>
                    <TimeBasedTriggeringPolicy interval="1"
                        modulate="true" />
                    <SizeBasedTriggeringPolicy size="10 MB" />

                </Policies>
            </RollingFile>
            <Rewrite name="rewrite" >
                <Appender-Ref ref="web3" />
                 <MapRewritePolicy">
                    <KeyValuePair key="creditCard" value="new12345"/>
                </MapRewritePolicy> 
            </Rewrite>
    </Appenders>
    <Loggers>
        <Logger name="com.virginamerica" level="info" additivity="false">
            <!-- <Appender-Ref ref="web3" /> -->
            <Appender-Ref ref="rewrite"/>
        </Logger>
    </Loggers>
</Configuration>

Answer 1

MapRewritePolicy将评估包含MapMessage的LogEvent，并将添加或更新Map的元素。这仅适用于您的应用程序调用logger.info(new MapMessage(keyValueMap))。我怀疑这不是你的应用程序目前正在做的事情。

通常，您的消息将是SimpleMessage（如果您调用logger.info("Just a string without parameters")）或ParameterizedMessage（如果您调用logger.info("Hi {}!", name)）。 RewriteAppender将无法对SimpleMessage或ParameterizedMessages执行任何操作，因此不会替换任何内容...

您可能需要查看PatternLayout的文档：如果使用replace{pattern}{regex}{substitution}模式，则可以使用某些替换值替换字符串消息中的正则表达式。

Answer 2

解决方案1：使用RewriteAppender

你的例子几乎是正确的。正如@Remko Popma所提到的，您选择的Rewrite实现不适合您的用例。

如果您使用自己的重写器实现，您可以使其工作。

我在这里找到了一个非常好的例子：RewriteAppender Example

该示例包含log4j2.xml和RewriteAppender的实现。在RewriteAppender（此处称为MarkerInjectorRewritePolicy）中，您可以修改事件以满足您的需求。在示例中，作者注入了一些标记数据，您不需要该部分。

.

解决方案2：使用LogEventFactory

解决方案1有一些缺点。想象一下，你有100个伐木工和50个Appender。现在，您尝试实施解决方案1，最后再使用50个RewriteAppender声明，并调整所有记录器以使用重定向记录器而不是实际的目标Appender。这可能非常繁琐且容易出错。

一个更简单的解决方案是：

// Do this somewhere before using the logger
System.setProperty(Constants.LOG4J_LOG_EVENT_FACTORY, MyLogEventFactory.class.getName());

或者使用start参数设置它：

-DLog4jLogEventFactory=my.package.MyLogEventFactory

编辑：更好：一个更健壮的方式设置这是通过使用log4j2.component.properties：

• 创建一个名为log4j2.component.properties的文本文件并将其放在类路径中。
• 把这段代码放进去：Log4jLogEventFactory = my.package.MyLogEventFactory

此文件由log4j自动加载，用于配置多个核心设置。使用此文件，您不必每次都传递启动参数，另外您不会遇到类初始化排序问题的潜在问题（例如使用System.setProperty()时）。

LogEventFactory实现非常简单：

public class MyLogEventFactory implements LogEventFactory {

    @Override
    public LogEvent createEvent(String loggerName, Marker marker, String fqcn, Level level, Message message,
            List<Property> properties, Throwable t) {
        { // In my case i wanted "log.error(new Exception(msg))"
          // to pass the exception properly to the event,
          // as if "log.error(msg, new Exception(msg))" was called.
            if (t == null && message instanceof ObjectMessage) {
                ObjectMessage msg = (ObjectMessage) message;
                t = msg.getThrowable();
            }
        }
        // XXX do your adjustments here
        return new Log4jLogEvent(loggerName, marker, fqcn, level, message, properties, t);
    }

}

LogEventFactory用于创建LogEvents。因此，我们不是在以后拦截和操纵它们，而只是去源头并在这里完成我们的工作。

有了这个，我们得到所有活动！

祝好运！玩得开心！