日志返回文件追加器不会立即刷新

java logging flush io logback

2022-09-02 22:23:30

在某些情况下，我需要立即在logback的文件追加器中强制刷新。我发现在文档中，此选项默认处于启用状态。神秘的是，这不起作用。正如我在源中看到的底层过程涉及正确。有任何问题吗？这可能与冲洗问题有关。BufferedOutputSreamBufferedOutputSream.flush()

更新：我在Windows XP Pro SP 3和Red Hat Enterprise Linux Server Release 5.3（Tikanga）上发现了这个问题。我用了这些库：

jcl-over-slf4j-1.6.6.jar
logback-classic-1.0.6.jar
logback-core-1.0.6.jar
slf4j-api-1.6.6.jar

它是：logback.xml

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>/somepath/file.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>file.log.%i</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>5MB</maxFileSize>
        </triggeringPolicy>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="FILE"/>
    </root>
</configuration>

更新：我会提供一个单元测试，但这似乎并不那么简单。让我更清楚地描述这个问题。

发生日志记录事件
事件传递到文件追加器中
使用定义的模式序列化事件
事件的序列化消息被传递到文件追加器，并即将写出到输出流
写入流完成，输出流被刷新（我已经检查了实现）。请注意，默认情况下为 true，因此显式调用方法immidiateFlushflush()
文件中没有结果！

稍后，当某个基础缓冲区被流动时，事件将出现在文件中。所以问题是：输出流能保证立即刷新吗？

老实说，我已经通过实现我自己的解决方案解决了这个问题，该功能利用了即时同步的功能。任何有兴趣的人都可以关注这个。ImmediateRollingFileAppenderFileDescriptor

所以这不是一个日志问题。

答案 1

我决定把我的解决方案带给每个人。首先让我澄清一下，这不是一个日志备份问题，也不是一个JRE问题。这在javadoc中进行了描述，通常不应该成为问题，直到您面对一些关于文件同步的旧式集成解决方案。

因此，这是一个实现立即刷新的日志返回追加器：

public class ImmediateFileAppender<E> extends RollingFileAppender<E> {

    @Override
    public void openFile(String file_name) throws IOException {
        synchronized (lock) {
            File file = new File(file_name);
            if (FileUtil.isParentDirectoryCreationRequired(file)) {
                boolean result = FileUtil.createMissingParentDirectories(file);
                if (!result) {
                    addError("Failed to create parent directories for [" + file.getAbsolutePath() + "]");
                }
            }

            ImmediateResilientFileOutputStream resilientFos = new ImmediateResilientFileOutputStream(file, append);
            resilientFos.setContext(context);
            setOutputStream(resilientFos);
        }
    }

    @Override
    protected void writeOut(E event) throws IOException {
        super.writeOut(event);
    }

}

这是相应的输出流实用程序类。由于最初应该用于扩展的原始方法和字段的某些方法和字段具有打包的访问修饰符，我不得不扩展，而只是将其余部分和未更改的和复制到这个新方法中。我只显示更改后的代码：ResilientOutputStreamBaseOutputStreamResilientOutputStreamBaseResilientFileOutputStream

public class ImmediateResilientFileOutputStream extends OutputStream {

    // merged code from ResilientOutputStreamBase and ResilientFileOutputStream

    protected FileOutputStream os;

    public FileOutputStream openNewOutputStream() throws IOException {
        return new FileOutputStream(file, true);
    }

    @Override
    public void flush() {
        if (os != null) {
            try {
                os.flush();
                os.getFD().sync(); // this's make sence
                postSuccessfulWrite();
            } catch (IOException e) {
                postIOFailure(e);
            }
        }
    }

}

最后是配置：

<appender name="FOR_INTEGRATION" class="package.ImmediateFileAppender">
    <file>/somepath/for_integration.log</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
        <fileNamePattern>for_integration.log.%i</fileNamePattern>
        <minIndex>1</minIndex>
        <maxIndex>3</maxIndex>
    </rollingPolicy>
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
        <maxFileSize>5MB</maxFileSize>
    </triggeringPolicy>
    <encoder>
        <pattern>%d{HH:mm:ss.SSS} - %msg%n</pattern>
        <immediateFlush>true</immediateFlush>
    </encoder>
</appender>

答案 2

你做得很好 - 做得很好。这里有一个建议，让它更简洁：

public class ImmediateFlushPatternLayoutEncoder extends PatternLayoutEncoder {
    public void doEncode(ILoggingEvent event) throws IOException {
        super.doEncode(event);
        if (isImmediateFlush()) {
             if (outputStream.os instanceof FileOutputStream) {
                 ((FileOutputStream) outputStream.os).getFD().sync();
             }
        }
    }
}

在配置中，您必须使用该特定编码器：

<encoder class="ch.qos.logback.core.recovery.ImmediateFlushPatternLayoutEncoder">

未经测试。字段可能会存在可见性问题，需要使用 logback ch.qos.logback.core.recovery 包本身。

顺便说一句，我邀请您提交错误报告以登录以获取其他选项。immediateSyncLayoutWrappingEncoder