如何为部署在 WildFly 9 中的应用程序设置 Log4j2？

Question

当我使用 JUnit 测试我的应用程序时，它会按照 log4j2.xml 中指定的布局模式打印日志，但是当我部署我的应用程序时在 WildFly 9 中，我不再使用相同的格式。即使是 Log4j2 中的日志级别在服务器中部署时也不会反映。

JUnit 日志示例：

2016-02-15 11:14:16,314 DEBUG [main] b.t.r.c.XAPool - a connection's state changed to IN_POOL, notifying a thread eventually waiting for a connection

服务器日志示例：

11:11:33,796 INFO [org.quartz.core.QuartzScheduler] (ServerService Thread Pool -- 89) Scheduler quartzScheduler_$_anindya-ubuntu1455514892022 started.

Log4j2.xml:

<Configuration status="WARN" name="myapp" monitorInterval="5">
    <Appenders>
        <RollingFile name="RollingFile" fileName="${myapp.log-dir}/myapp.log"
                     filePattern="${myapp.log-dir}/$${date:yyyy-MM}/myapp-%d{MM-dd-yyyy}-%i.log">
            <PatternLayout>
                <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
            </PatternLayout>
            <Policies>
                <OnStartupTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="25 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="100">
                <Delete basePath="${myapp.log-dir}" maxDepth="2">
                    <IfFileName glob="*/myapp-*.log">
                        <IfLastModified age="7d">
                            <IfAny>
                                <IfAccumulatedFileSize exceeds="1 GB" />
                                <IfAccumulatedFileCount exceeds="1" />
                            </IfAny>
                        </IfLastModified>
                    </IfFileName>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Logger name="com.company.myapp" level="trace" additivity="false">
            <AppenderRef ref="RollingFile"/>
        </Logger>
        <Root level="info">
            <AppenderRef ref="RollingFile"/>
        </Root>
    </Loggers>
</Configuration>

启动服务器时，我提供以下启动属性 JAVA_OPTS:

export JAVA_OPTS="$JAVA_OPTS -Dspring.profiles.active='qa' -Dlog4j.configurationFile=/home/anindya/1.0/log4j2.xml -myapp.log-dir=/home/anindya/log -Dorg.jboss.logging.provider=log4j"

我在 web.xml 中没有特定设置，因为它是 Servlet 3.1 容器。但是我的 WEB-INF 中有一个 jboss-deployment-structure.xml，如下所示：

<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
    <deployment>
        <!-- Exclusions allow you to prevent the server from automatically adding some dependencies -->
        <exclusions>
            <module name="org.apache.logging.log4j" />
        </exclusions>
    </deployment> 
</jboss-deployment-structure>

最后，这是我的类路径依赖项（这里只提到相关部分）：

hibernate-5.0.7.Final 依赖关系
jbpm-6.3.0.Final 依赖关系
spring-4.2.4.RELEASE 依赖关系
commons-logging-1.2.jar
log4j-1.2-api-2.5.jar
log4j-api-2.5.jar
log4j-core-2.5.jar
log4j-jcl-2.5.jar
log4j-slf4j-impl-2.5.jar
log4j-web-2.5.jar
jboss-logging-3.3.0.Final.jar

经过上述所有设置，我仍然无法根据我的 log4j2.xml 在 WildFly 环境中配置 Log4j2。有人可以帮忙吗？

注意：我是运行 WildFly，处于独立模式，我想避免使用 jboss-cli。

Answer 1

没有模块org.apache.logging.log4j。您应该使用的模块名称是 org.apache.log4j.

我不确定您为什么不想使用 CLI，但您也可以将 add-logging-api-dependencies 设置为 false。

/subsystem=logging:write-attribute(name=add-logging-api-dependencies, value=false)

Answer 2

我设法通过使用下面的 jboss-deployment-structure.xml.

让它工作

<jboss-deployment-structure xmlns="urn:jboss:deployment-structure:1.2">
    <deployment>
        <exclusions>
            <module name="org.apache.logging.log4j" />
        </exclusions>
        <exclude-subsystems>
            <subsystem name="logging"/>
        </exclude-subsystems>
    </deployment>
</jboss-deployment-structure>

我所要做的就是排除日志子系统。

Answer 3

比赛晚了，但我需要 Wildfly 中的 log4j2 支持，我想我会与其他面临此问题的人分享一些细节。此解决方案将让您通过 standalone.xml 配置日志记录，即没有 log4j2.xml 将 used/picked 起来。我选择的解决方案是桥接log4j2到slf4j。 Wildfly 支持开箱即用的 slf4j。对于高级用户，一句话解决方案是'Create a Wildfly module and use it'，对于像我这样的其他人，解决方案如下更详细......

首先创建一个 wildfly 模块，我不会详细说明这是如何完成的，但我的 module.xml 最终看起来像这样

<module xmlns="urn:jboss:module:1.1" name="org.apache.logging.log4j2">
<resources>
    <resource-root path="log4j-api-2.11.1.jar"/>
    <resource-root path="log4j-to-slf4j-2.11.1.jar"/>
</resources>

<dependencies>
    <module name="org.slf4j" />
</dependencies>
</module>

（基本上确保这个 xml 在你的模块路径中，通常你会在 $JBOSS_MODULEPATH/org/apache/logging/log4j2/main/module.xml 中添加它，并将引用的 jar 文件也直接添加到相同的路径中）

下一步是从我的应用程序向该模块添加依赖项。这是使用 jboss-deployment-structure.xml 完成的。如果您不熟悉此文件，请查找它。添加这样一行

<module name="org.apache.logging.log4j2" export="true" />

您可能还需要从您的应用程序部署中排除 log4j-api-2.11.1.jar，我不是 100% 确定需要它，但我在创建模块时总是这样做。

在此之后，您应该能够在 server.log

中看到 log4j2 消息

我希望这可以帮助那里的人！

Answer 4

我想提出从另一个角度看问题。

您可以在您的代码中使用 log4j2 接口，作为日志记录的桥梁。例如，您可以使用 MDC、供应商、ClosableThreadContext。目前 slf4j/logback 中不可用的功能：

import org.apache.logging.log4j.CloseableThreadContext;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;


  private static final Logger logger = LogManager.getLogger(SomeClass.class.getName());

  public void doLog() {
    try (final CloseableThreadContext.Instance ctc =
           CloseableThreadContext.put("user", UUID.randomUUID().toString())) {
      String note = "(originally, log4j2 war)";
      logger.info(() -> "This is an info message, via supplier, " + note);      // == INFO
      logger.error("This is an error message, {}", note);   // == ERROR
      logger.warn("This is a warning message, {}", note); // == WARNING
      logger.debug("Here is a debug message, {}", note);      // == DEBUG
      logger.info(logger.getClass().getName());
    }
  }

但是你添加了一个依赖来将所有 log4j2 调用委托给 slf4j:

<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-to-slf4j</artifactId>
  <version>2.14.0</version>
</dependency>

您不需要任何其他技巧。它工作正常（在 Wildfly 10 上检查过）。

主要优点：

您拥有用于日志记录的现代 API 和一些很棒的功能。 Slf4j 将支持这些功能，但它们尚未包含在最后的最终版本中。
更重要的是，当您使用 WildFly 时，您可以在运行时使用 CLI 通过 WildFly 采用日志记录配置。这对于生产来说是非常重要的可能性。提供一个配置文件，比如 Log4j2.xml 是一个糟糕的选择。您需要从字面上更改此文件的内容。大多数情况下，这意味着重建项目，因为日志记录配置文件通常是 resources 的一部分。这也意味着您需要重新部署应用程序。

使用 WildFly CLI，我可以为某个包临时启用 DEBUG 模式。

如何为部署在 WildFly 9 中的应用程序设置 Log4j2？

How to setup Log4j2 for an application deployed in WildFly 9?

java

log4j2

wildfly

wildfly-9