java - Spring Boot 和 Log4J2 的奇怪行为

Question

运行 Spring Boot 应用程序时，我遇到了一些奇怪的问题。它已配置为使用 Log4J2 作为其记录器(Logback 记录器已被禁用)。

log4j2.xml:

<Configuration status="WARN" monitorInterval="30">
  <Properties>
    <Property name="serviceName">$${sys:service.name}</Property>
    <Property name="serviceId">$${sys:service.id}</Property>

    <Property name="LOG_PATTERN">
      [%d{yyyy-MM-dd HH:mm:ss.SSS}] %t %-5p: %c{2}:%L - %m%n
    </Property>

    <Property name="STATS_PATTERN">
      %m%n
    </Property>

    <Property name="logFile">logs/$${sys:service.name}-$${sys:service.id}</Property>
    <Property name="statsFile">metrics/$${sys:service.name}-$${sys:service.id}_stats.json</Property>
    <!--
    <Property name="logFile">logs/${serviceName}-${serviceId}</Property>
    <Property name="statsFile">metrics/${serviceName}-${serviceId}_stats.json</Property>
    -->
  </Properties>

  <Appenders>
    <Console name="ConsoleAppender" target="SYSTEM_OUT" follow="true">
      <PatternLayout pattern="${LOG_PATTERN}" />
    </Console>

    <RollingFile name="RollingFile" fileName="${logFile}.current-session.log"
      filePattern="${logFile}.%i.log.gz" ignoreExceptions="false">
      <PatternLayout>
        <Pattern>${LOG_PATTERN}</Pattern>
      </PatternLayout>
      <Policies>
        <OnStartupTriggeringPolicy />
        <SizeBasedTriggeringPolicy size="10 MB" />
      </Policies>
      <DefaultRolloverStrategy max="10" />
    </RollingFile>

    <File name="StatsFile" fileName="${statsFile}" append="false">
      <PatternLayout>
        <Pattern>${STATS_PATTERN}</Pattern>
      </PatternLayout>
    </File>
  </Appenders>

  <Loggers>
    <Logger name="<package>.StatsWriter" level="info" additivity="false">
      <AppenderRef ref="StatsFile" />
    </Logger>

    <Root level="info">
      <AppenderRef ref="ConsoleAppender" />
    </Root>
  </Loggers>
</Configuration>

主要问题

我在 log4j2.xml 文件中进行了一些变量替换，以允许变化，特别是日志文件名。当我运行该应用程序时，日志文件会在正确的目录中创建，并且看起来确实具有实际的日志内容。问题是它们的命名不正确。例如，该文件的名称不是 Client-1.current-session.log，而是 ${sys:service.name}-${sys:service.id}.current-session .log。显然变量替换没有按计划进行。

属性 service.name 和 service.id 是当前在关联的 application.yml 文件中定义的 Spring Boot 配置参数。我本以为文件中的属性是可用的，但显然事实并非如此。

有没有办法让 application.yml 属性在这里可用？如果这不可行，有什么其他建议可以实现这一目标？

次要问题

当我在测试环境中执行应用程序时，我将记录器设置为输出到控制台:

<Root level="info">
  <AppenderRef ref="ConsoleAppender" />
</Root>

当它执行时，输出显示在控制台上，但奇怪的是，日志文件也被创建。为什么会这样？

注意:

有一个现有的SO项目( Use Spring boot application properties in log4j2.xml )(这是第二个答案)可以解决这个问题，但看起来(正如作者承认的那样)有点hacky。我还没有尝试过。

我对 application-"profile".yml 和 log4j2-spring.xml 的引用有点困惑。我不熟悉这些文件名的这些变体。这些变化(两种文件类型)的意义是什么？

Answer 1

对于您的主要问题，您的文件名是log4j2.xml，您应该使用log4j2-spring.xml，因为这样您就允许Spring Boot 可以更好地控制 Log4j2。

好处之一是可以整合您缺少的变量。这可能是由于使用 log4j2.xml 文件使 log4j2 在 Spring Boot 之前初始化，而使用 log4j2-spring.xml 文件使 Spring Boot 初始化 log4j2。

作为SpringBoot documentation状态:

When possible, we recommend that you use the -spring variants for your logging configuration (for example, logback-spring.xml rather than logback.xml). If you use standard configuration locations, Spring cannot completely control log initialization.

您可以看看this thread由一个要求 log4j2.xml 与 log4j2-spring.xml

的人打开

对于你的第二个问题，因为你有 2 个记录器......简单地说:

  <Loggers>
    <Logger name="<package>.StatsWriter" level="info" additivity="false">
      <AppenderRef ref="StatsFile" />   <---- This one creates your file
    </Logger>

    <Root level="info">
      <AppenderRef ref="ConsoleAppender" />
    </Root>
  </Loggers>

关于您的第三个问题:

I'm a little confused by references to application-"profile".yml and log4j2-spring.xml. I'm not familiar with these variations on these file names. What is the significance of these variations (of both file types)?

application-"profile".xxx 的变体是一种允许 Spring Boot 根据这些配置文件采用不同配置的方式。您可以使用“dev”参数(本地开发数据库)启动应用程序，但在生产中您可以使用不同的参数。您可以控制如何通过不同的方式引导不同的配置文件，一种非常常见的方式是执行您的应用程序，例如 java -jar -Dspring.profiles.active=prod application.jar

与 log4j2-spring.xml 相关，如上所述，允许 Spring Boot 正确初始化 log4j2(或您使用的任何日志记录工具)。