如何将 Jenkins 与现代日志框架一起使用？

Question

Jenkins 默认使用 Java Utils Logging。这是一个有点过时的日志框架，缺乏现代日志框架（如 Log4J 或 Logback）的许多功能。

如何使用 Logback 或 Log4J 在 Tomcat 上部署/配置 Jenkins？

Answer 1

Jenkins 主要使用 Java Utils Logging (JUL)，一些依赖项和插件使用 SLF4J。 JUL 无法替换，但可以将 logger 输出重定向到 SLF4J（请参阅http://www.slf4j.org/legacy.html#jul-to-slf4j）并在使用 Logback 时将日志配置传播到 JUL（http://logback.qos.ch/manual/configuration.html#LevelChangePropagator）。

Jenkins 捆绑了 slf4j-jdk14 JUL 绑定（参见https://github.com/jenkinsci/jenkins/blob/jenkins-1.620/war/pom.xml#L144）。此绑定必须替换为 logback。这可以通过修补 jenkins-war pom 或手动将 WEB-INF/lib/slf4j-jdk14-1.7.7.jar 替换为 logback-classic-1.1.3.jar 和 logback-core-1.1.3 来完成。 jar (Jenkins-1.620)。

JUL 网桥可以通过在 WEB-INF/classes/ 中放置一个 logging.properties 文件（JULI 配置，参见https://tomcat.apache.org/tomcat-7.0-doc/logging.html#Using_java.util.logging_%28default%29）来安装

handlers = org.slf4j.bridge.SLF4JBridgeHandler
.handlers = org.slf4j.bridge.SLF4JBridgeHandler

以下示例 logback 配置（将放在 WEB-INF/classes/logback.xml 中）启用 Logback 内部日志记录 (debug="true") 并激活 LevelChangePropagator：

<configuration debug="true">
  <contextListener class="ch.qos.logback.classic.jul.LevelChangePropagator" />
  <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>/home/jenkins/work/log/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
      <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <maxFileSize>10MB</maxFileSize>
      </timeBasedFileNamingAndTriggeringPolicy>
      <maxHistory>50</maxHistory>
    </rollingPolicy>
    <encoder>
      <pattern>%date{HH:mm:ss.SSS} %-5level [%thread] %logger %msg%n</pattern>
    </encoder>
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>WARN</level>
    </filter>
  </appender>   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%-4relative %-5level [%thread] %logger %msg %n</pattern>
    </encoder>
  </appender>
  <root level="debug">
    <appender-ref ref="WARN" />
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

Tomcat JULI 日志记录是一个特定于 Tomcat 的 LogManager (http://docs.oracle.com/javase/7/docs/api/java/util/logging/LogManager.html) 实现，它允许特定于 ClassLoader 的 JUL 配置。因此，上述配置的范围特定于 Jenkins webapp。