有两种方法可以让 log4j2 找到您的自定义插件:通过 packages 配置属性和通过 javac 生成的插件 dat 文件。
选项 1:packages 属性
有一个旧版本的 log4j2,其中 packages 属性不再起作用,但是 2.0.1 中的 was fixed。这应该不再是问题了。
要使用此选项,请将插件类的包名放在packages 属性中。例如,如果您的插件的完全限定类名是com.mycompany.myproduct.MyPlugin,那么您的 log4j2.xml 配置文件以
开头
<Configuration status="trace" packages="com.mycompany.myproduct">
...
status="trace" 属性将显示控制台上显示的内部 log4j2 调试语句。这可能有助于解决任何问题,例如找不到您的插件时。
选项 2:插件 dat 文件
如果您在类路径中使用 log4j-core jar 进行编译,javac 将生成一个 log4j2 插件 dat 文件。 Maven 会自动将其包含在您的 jar 中,但如果您不使用 maven,您可以手动将此文件包含到您的 jar 中。同样,如有必要,请使用 status="trace" 进行故障排除。
配置
完成上述任一操作后,log4j2 即可找到您的插件。下一步是正确配置您的插件。这可能是导致问题的原因。
假设您的插件是一个自定义查找,如下所示:
package com.mycompany.myproduct;
@Plugin(name = "FabLookup", category = StrLookup.CATEGORY)
public class BetterLookup extends AbstractLookup {
@Override
public String lookup(final LogEvent event, final String key) {
return com.mycompany.SomeClass.getValue(key);
}
}
现在,您声明了插件的名称FabLookup,所以这就是您需要在配置中使用的名称。不是类名(尽管它们可以相同)。
使用您的插件的示例配置如下所示:
<Configuration status="trace" packages="com.mycompany.myproduct">
...
<Appenders>
<RollingFile name="RollingFile" fileName="logs/app.log"
filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}.log.gz">
<!-- use custom lookups to access arbitrary internal system info -->
<PatternLayout header="${FabLookup:key1} ${FabLookup:key2}">
<Pattern>%d %m%n</Pattern>
</PatternLayout>
<Policies>
<TimeBasedTriggeringPolicy />
</Policies>
</RollingFile>
...
如果以上内容不足以解决问题,请发布更多细节,例如您的插件在 java 代码中的声明方式以及在 log4j2.xml 中的配置方式。