如何在 logback 中启动时滚动日志文件

Question

我想配置 logback 来执行以下操作。

• 记录到文件
• 当文件达到 50MB 时
• 滚动文件 只保留 7 天的日志
• 在启动时总是生成一个新文件（滚动）

除了最后一项（启动滚动）之外，我一切都正常工作。有谁知道如何实现这一目标？这是配置...

  <appender name="File" class="ch.qos.logback.core.rolling.RollingFileAppender">

    <layout class="ch.qos.logback.classic.PatternLayout">
      <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg \(%file:%line\)%n</Pattern>
    </layout>

    <File>server.log</File>

    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <FileNamePattern>server.%d{yyyy-MM-dd}.log</FileNamePattern>
      <!-- keep 7 days' worth of history -->
      <MaxHistory>7</MaxHistory>

      <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <MaxFileSize>50MB</MaxFileSize>
      </TimeBasedFileNamingAndTriggeringPolicy>

    </rollingPolicy>
  </appender>

Answer 1

其他建议都不适合我的情况。我不想使用基于大小和时间的解决方案，因为它需要配置 MaxFileSize，而我们正在使用严格基于时间的策略。以下是我如何使用 TimeBasedRollingPolicy 在启动时滚动文件：

@NoAutoStart
public class StartupTimeBasedTriggeringPolicy<E> 
        extends DefaultTimeBasedFileNamingAndTriggeringPolicy<E> {

    @Override
    public void start() {
        super.start();
        nextCheck = 0L;
        isTriggeringEvent(null, null);
        try {
            tbrp.rollover();
        } catch (RolloverFailure e) {
            //Do nothing
        }
    }

}

技巧是将 nextCheck 时间设置为 0L，以便 isTriggeringEvent() 认为是时候滚动日志文件了。因此，它将执行计算文件名所需的代码，并方便地重置 nextCheck 时间值。随后对 rollover() 的调用会导致日志文件滚动。由于这仅在启动时发生，因此它是比在 isTriggerEvent() 内执行比较的解决方案更优化的解决方案。无论这个比较多么小，当对每条日志消息执行时，它仍然会稍微降低性能。这还强制在启动时立即进行翻转，而不是等待第一个日志事件。

@NoAutoStart 注释对于防止 Joran 在所有其他初始化完成之前执行 start() 方法非常重要。否则，您将得到 NullPointerException。

这是配置：

  <!-- Daily rollover appender that also appends timestamp and rolls over on startup -->
  <appender name="startupDailyRolloverAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${LOG_FILE}</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>${LOG_FILE}.%d{yyyyMMdd}_%d{HHmmss,aux}</fileNamePattern>
      <TimeBasedFileNamingAndTriggeringPolicy class="my.package.StartupTimeBasedTriggeringPolicy" />
    </rollingPolicy>
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender> 

希望这有帮助！

Answer 2

对于使用现有组件的解决方案，logback 建议使用唯一命名的文件：http://logback.qos.ch/manual/appenders.html#uniquelyNamed

在应用程序开发阶段或短暂的情况下
应用程序，例如批处理应用程序，需要创建一个新的
每次新应用程序启动时的日志文件。这很容易做到
在 元素的帮助下。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <timestamp key="startTimestamp" datePattern="yyyyMMddHHmmssSSS"/>
    <appender name="File"
    class="ch.qos.logback.core.rolling.RollingFileAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg \(%file:%line\)%n</Pattern>
        </layout>

        <file>server-${startTimestamp}.log</file>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>server-${startTimestamp}-%d{yyyy-MM-dd}-%i.log</FileNamePattern>
            <!-- keep 7 days' worth of history -->
            <MaxHistory>7</MaxHistory>

            <TimeBasedFileNamingAndTriggeringPolicy
            class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <MaxFileSize>1KB</MaxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender>
    <root level="DEBUG">
        <appender-ref ref="File" />
    </root>
</configuration>

---

已更新 logback-1.2.1

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <timestamp key="startTimestamp" datePattern="yyyyMMddHHmmssSSS"/>
    <appender name="File"
    class="ch.qos.logback.core.rolling.RollingFileAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg \(%file:%line\)%n</Pattern>
        </layout>

        <file>server-${startTimestamp}.log</file>

        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>server-${startTimestamp}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <maxFileSize>10MB</maxFileSize>
            <!-- keep 7 days' worth of history -->
            <maxHistory>7</maxHistory>
            <totalSizeCap>20GB</totalSizeCap>
        </rollingPolicy>
    </appender>
    <root level="DEBUG">
        <appender-ref ref="File" />
    </root>
</configuration>

Answer 3

它对我有用，使用以下类作为 timeBasedFileNamingAndTriggeringPolicy ：

import java.io.File;
import java.util.concurrent.atomic.AtomicBoolean;

import ch.qos.logback.core.joran.spi.NoAutoStart;
import ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP;

@NoAutoStart
public class Trigger<E> extends SizeAndTimeBasedFNATP<E>
{
    private final AtomicBoolean trigger = new AtomicBoolean();

    public boolean isTriggeringEvent(final File activeFile, final E event) {
        if (trigger.compareAndSet(false, true) && activeFile.length() > 0) {
            String maxFileSize = getMaxFileSize();
            setMaxFileSize("1");
            super.isTriggeringEvent(activeFile, event);
            setMaxFileSize(maxFileSize);
            return true;
        }
        return super.isTriggeringEvent(activeFile, event);
    }
}

Answer 4

我找到了另一种解决方案，可以在应用程序启动时滚动一次日志文件。

我将 logback 的 RollingFileAppender 与 logback 的 FixedWindowRollingPolicy 以及我自己的 TriggeringPolicy 实现结合使用。

FixedWindowRollingPolicy 获取新日志文件的 fileNamePattern，其中 %1 是文件的新编号。 maxIndex 代表我的“历史”的最大数量。详细信息： FixedWindowRollingPolicy

我的实现 TriggeringPolicy 返回 true 第一次，当 isTriggeringEvent(...) 被调用时。因此，当第一次调用该策略时，WindowRollingPolicy 会滚动日志文件，之后就不会再次滚动。

RollingFileAppender 的 xml 配置：

<configuration>
    ...
    <appender name="FILE_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logFile.log</file>

        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>logFile.%i.log</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>4</maxIndex>
        </rollingPolicy>

        <triggeringPolicy class="my.classpath.RollOncePerSessionTriggeringPolicy"/>
    </appender>
...
</configuration>

TriggeringPolicy：

package my.classpath;

import ch.qos.logback.core.rolling.TriggeringPolicyBase;

import java.io.File;

public class RollOncePerSessionTriggeringPolicy<E> extends TriggeringPolicyBase<E> {
    private static boolean doRolling = true;

    @Override
    public boolean isTriggeringEvent(File activeFile, E event) {
        // roll the first time when the event gets called
        if (doRolling) {
            doRolling = false;
            return true;
        }
        return false;
    }
}

Answer 5

重写 ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP 中的 isTriggeringEvent() 方法应该可以很好地工作。第一次调用 isTriggeringEvent() 方法时只需返回“true”。

Answer 6

Ceki 的解决方案似乎对我不起作用，但似乎至少是其中的一部分。

它会爆炸，因为它在启动 TimeBasedFileNamingAndTriggeringPolicyBase 时看不到滚动策略。通过一些黑客行为，我让它做一些日志记录，通过更多的操作，我让它观察触发器，但后来它再次崩溃，因为它无法解析文件名属性之一......该包是一个 logback 包，所以我可以访问一些内部结构，复制 SizeAndTimeBasedFNATP#isTriggeringEvent 中的一些逻辑并调用 computeCurrentPeriodsHighestCounterValue。我认为类似的东西可能会起作用，只是还没有找到神奇的组合。我真的希望我在做一些愚蠢的事情，因为否则我认为这将意味着要么开放一些子类化的细节，要么将其直接放入 logback 作为另一个滚动/触发策略。

logback.xml：在 rollingPolicy 内部和外部尝试了 triggeringPolicy、TimeBasedFileNamingAndTriggeringPolicy 的各种顺序。

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${LOG_DIR}/${LOG_FILE_BASE}.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>${LOG_DIR}/${LOG_FILE_BASE}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
        <MaxHistory>7</MaxHistory>

        <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.RollOnStartupPolicy" />
    </rollingPolicy>

    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>INFO</level>
    </filter>

    <encoder>
        <pattern>%msg%n</pattern>
    </encoder>
</appender>

触发策略：

package ch.qos.logback.core.rolling;
public class RollOnStartupPolicy<E> extends SizeAndTimeBasedFNATP<E> {
private final AtomicBoolean firstTime = new AtomicBoolean(true);

    @Override
    public boolean isTriggeringEvent(File activeFile, E event) {
        if (!firstTime.get()) { // fast path
            return false;
        }

        if (firstTime.getAndSet(false)) {
            return true;
        }
        return false;
    }
}

例外情况：

java.lang.NullPointerException
at  at ch.qos.logback.core.rolling.TimeBasedFileNamingAndTriggeringPolicyBase.start(TimeBasedFileNamingAndTriggeringPolicyBase.java:46)
at  at ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP.start(SizeAndTimeBasedFNATP.java:36)
at  at ch.qos.logback.core.joran... [snip joran config]

Answer 7

API 已更改（例如 setMaxFileSize 不再存在），并且上面的很多内容似乎不起作用，但我有一些针对 logback 1.1.8（目前最新的）的东西对我有用。

我想在启动和规模上滚动，但不是时间。这样就可以了：

public class RollOnStartupAndSizeTriggeringPolicy<E> extends SizeBasedTriggeringPolicy<E> {
    private final AtomicBoolean firstTime = new AtomicBoolean();

    public boolean isTriggeringEvent(final File activeFile, final E event) {
        if (firstTime.compareAndSet(false, true) && activeFile != null && activeFile.length() > 0) {
            return true;
        }
        return super.isTriggeringEvent(activeFile, event);
    }
}

有了这个，您还需要一个滚动策略。 FixWindowRollingPolicy 可能可以，但我不喜欢它，因为我想保留大量文件，而且效率非常低。一些递增的数字（而不是像固定窗口那样滑动）可以工作，但这种情况并不存在。只要我自己写，我就决定使用时间而不是计数。我想扩展当前的 logback 代码，但对于基于时间的内容，滚动和触发策略通常被组合到一个类中，并且存在嵌套和循环内容以及没有吸气剂的字段的日志，所以我发现这是相当不可能的。所以我必须从头开始做很多事情。我保持简单，没有实现压缩等功能 - 我很想拥有它们，但我只是想保持简单。

public class TimestampRollingPolicy<E> extends RollingPolicyBase {
    private final RenameUtil renameUtil = new RenameUtil();
    private String activeFileName;
    private String fileNamePatternStr;
    private FileNamePattern fileNamePattern;

    @Override
    public void start() {
        super.start();
        renameUtil.setContext(this.context);
        activeFileName = getParentsRawFileProperty();
        if (activeFileName == null || activeFileName.isEmpty()) {
            addError("No file set on appender");
        }
        if (fileNamePatternStr == null || fileNamePatternStr.isEmpty()) {
            addError("fileNamePattern not set");
            fileNamePattern = null;
        } else {
            fileNamePattern = new FileNamePattern(fileNamePatternStr, this.context);
        }
        addInfo("Will use the pattern " + fileNamePattern + " to archive files");
    }

    @Override
    public void rollover() throws RolloverFailure {
        File f = new File(activeFileName);
        if (!f.exists()) {
            return;
        }
        if (f.length() <= 0) {
            return;
        }
        try {
            String archiveFileName = fileNamePattern.convert(new Date(f.lastModified()));
            renameUtil.rename(activeFileName, archiveFileName);
        } catch (RolloverFailure e) {
            throw e;
        } catch (Exception e) {
            throw new RolloverFailure(e.toString(), e);
        }
    }

    @Override
    public String getActiveFileName() {
        return activeFileName;
    }

    public void setFileNamePattern(String fnp) {
        fileNamePatternStr = fnp;
    }
}

然后配置看起来像

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
  </encoder>
  <file>/tmp/monitor.log</file>
  <rollingPolicy class="my.log.TimestampRollingPolicy">
    <fileNamePattern>/tmp/monitor.%d{yyyyMMdd-HHmmss}.log</fileNamePattern>
  </rollingPolicy>
  <triggeringPolicy class="my.log.RollOnStartupAndSizeTriggeringPolicy">
    <maxFileSize>1gb</maxFileSize>
  </triggeringPolicy>
</appender>

如果你感到沮丧，这本身没有解决，请在

http: //jira.qos.ch/browse/LOGBACK-204

http://jira .qos.ch/browse/LOGBACK-215

（已经过去很多年了，对我来说这绝对是关键功能，尽管我知道许多其他框架也失败了）

Answer 8

我终于弄清楚了。我可以按尺寸、时间滚动并启动。这是解决方案：

第一创建自己的类

@NoAutoStart
public class StartupSizeTimeBasedTriggeringPolicy<E> extends SizeAndTimeBasedFNATP<E> {

    private boolean started = false;

    @Override
    public boolean isTriggeringEvent( File activeFile, E event ) {
        if ( !started ) {
            nextCheck = 0L;
            return started = true;
        }

        return super.isTriggeringEvent( activeFile, event );
    };
}

第二配置 logback

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${LOGS_DIR}/${FILE_NAME}.log</file>
    <encoder>
        <pattern>%d [%thread] %-5level %logger{50} - %msg%n</pattern>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>${LOGS_DIR}/${FILE_NAME}.%d{yyyy-MM-dd}_%d{HHmmss,aux}.%i.log.zip</fileNamePattern>
        <maxHistory>30</maxHistory>
        <TimeBasedFileNamingAndTriggeringPolicy class="my.StartupSizeTimeBasedTriggeringPolicy">
            <MaxFileSize>250MB</MaxFileSize> 
        </TimeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>
</appender>

Answer 9

创建您自己的 ch.qos.logback.core.rolling.TimeBasedRollingPolicy 子类并覆盖其 start

public class MyPolicy
    extends ch.qos.logback.core.rolling.TimeBasedRollingPolicy
{

    public void start ( )
    {
        super.start( );
        rollover( );
    }
}

Answer 10

我得到了以下工作（结合以前答案的想法）。请注意，我正在处理基于大小的文件，而不是基于时间的文件，但我猜测相同的解决方案有效。

public class StartupSizeBasedTriggeringPolicy<E> extends ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy<E> {

private final AtomicReference<Boolean> isFirstTime = new AtomicReference<Boolean>(true);

@Override
public boolean isTriggeringEvent(final File activeFile, final E event) {

    //this method appears to have side-effects so always call
    boolean result = super.isTriggeringEvent(activeFile, event);

    return isFirstTime.compareAndSet(true, false) || result;
}

}

Answer 11

这个解决方案确实有效，非常感谢。
然而，有一个恼人的故障：当您第一次运行该程序时，日志在创建后立即滚动，此时日志为空或几乎为空。
所以我建议修复：检查日志文件是否存在并且在调用该方法时不为空。
另外，还有一项修饰性修复：重命名“started”变量，因为它隐藏了具有相同名称的继承成员。

@NoAutoStart
public class StartupSizeTimeBasedTriggeringPolicy<E> extends     SizeAndTimeBasedFNATP<E> {

    private boolean policyStarted;

    @Override
    public boolean isTriggeringEvent(File activeFile, E event) {
        if (!policyStarted) {
            policyStarted = true;
            if (activeFile.exists() && activeFile.length() > 0) {
                nextCheck = 0L;
                return true;
            }
        }
        return super.isTriggeringEvent(activeFile, event);
    }
}

另外，我相信它可以在 logback 版本 1.1.4-SNAPSHOT 上正常工作（我得到了源代码并自己编译了它），但它不能完全与 1.1.3 版本一起工作。在 1.1.3 中，它使用指定的时区正确命名文件，但翻转仍然会在默认时区午夜发生。

Answer 12

我找到了一种方法来做到这一点，不需要将自定义类注入到配置中。它利用测试 API 来欺骗附加程序，让其认为是时候滚动文件了。

此示例假设您在名为 ROLLING 的 XML 中配置了一个 RollingFileAppender，并使用 SizeAndTimeBasedRollingPolicy 设置为每日滚动：

<appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>./logs/${app-name}.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <fileNamePattern>./logs/${app-name}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
        <maxFileSize>100MB</maxFileSize>
        <maxHistory>5</maxHistory>
        <totalSizeCap>5GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
        <pattern>${LOG_PATTERN}</pattern>
    </encoder>
</appender>

下面的代码将找到滚动策略并触发滚动。请注意，这将在短时间内全局覆盖附加程序的时钟，因此当任何其他线程可能写入消息时不要调用它。

// get the root logger
ch.qos.logback.classic.Logger _logger = (ch.qos.logback.classic.Logger)LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);

// get the triggering policy from the rolling appender
RollingFileAppender<?> _appender = (RollingFileAppender<?>)_logger.getAppender("ROLLING");
SizeAndTimeBasedRollingPolicy<?> _policy = (SizeAndTimeBasedRollingPolicy<?>)_appender.getRollingPolicy();
TimeBasedFileNamingAndTriggeringPolicy<?> _trigger = _policy.getTimeBasedFileNamingAndTriggeringPolicy();

// trick the appender into thinking it is time to rollover
_trigger.setCurrentTime(System.currentTimeMillis() + 24*60*60*1000);

// this message will trigger the rollover
LOG.info("Initializing log for app: {}", _appName);

// turn off fake time
_trigger.setCurrentTime(0);