如果配置了“max-backup-index”属性，Wildfly如何知道需要删除多个文件？

Question

为了实现this issue，即max-backup-index的periodic-rotating-file-handler特征，我试图理解max-backup-index属性在size-rotating-file-handler中是如何工作的。

尝试

Wildfly读取xml配置：

<size-rotating-file-handler name="FILE" autoflush="true">
    <level name="INFO"/>
    <formatter>
        <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
    </formatter>
    <file relative-to="jboss.server.log.dir" path="server.log"/>
    <rotate-size value="100K"/>
    <max-backup-index value="10"/>
    <append value="true"/>
</size-rotating-file-handler>

如果日志文件的数量大于10，则Wildfly将删除文件，直到剩下10个。

已经查看驻留在Github上的Wildfly代码，以便了解哪些代码负责读取<max-backup-index value="10"/>片段并删除多余的日志文件。

PeriodicSizeRotatingHandlerResourceDefinition

class PeriodicSizeRotatingHandlerResourceDefinition extends AbstractFileHandlerDefinition {

    public static final String PERIODIC_SIZE_ROTATING_FILE_HANDLER = "periodic-size-rotating-file-handler";
    static final PathElement PERIODIC_SIZE_ROTATING_HANDLER_PATH = PathElement.pathElement(PERIODIC_SIZE_ROTATING_FILE_HANDLER);    

    static final AttributeDefinition[] ATTRIBUTES = Logging.join(DEFAULT_ATTRIBUTES, AUTOFLUSH, APPEND, MAX_BACKUP_INDEX, ROTATE_SIZE, ROTATE_ON_BOOT, SUFFIX, NAMED_FORMATTER, FILE);

    public PeriodicSizeRotatingHandlerResourceDefinition(final ResolvePathHandler resolvePathHandler) {
        super(PERIODIC_SIZE_ROTATING_HANDLER_PATH, false, PeriodicSizeRotatingFileHandler.class, resolvePathHandler, ATTRIBUTES);
    }

super指的是超类的构造函数，即AbstractFileHandlerDefinition

abstract class AbstractFileHandlerDefinition extends AbstractHandlerDefinition {
    protected AbstractFileHandlerDefinition(final PathElement path, final boolean registerLegacyOps,
                                            final Class<? extends Handler> type,
                                            final ResolvePathHandler resolvePathHandler,
                                            final AttributeDefinition... attributes) {
        super(path, registerLegacyOps, type, new DefaultPropertySorter(FileNameLastComparator.INSTANCE), attributes);
        this.registerLegacyOps = registerLegacyOps;
        this.resolvePathHandler = resolvePathHandler;
    }

超指AbstractHandlerDefinition

abstract class AbstractHandlerDefinition extends TransformerResourceDefinition {

    protected AbstractHandlerDefinition(final PathElement path,
                                        final boolean registerLegacyOps,
                                        final Class<? extends Handler> type,
                                        final PropertySorter propertySorter,
                                        final AttributeDefinition[] attributes) {
        this(path, registerLegacyOps, type, propertySorter, attributes, null, attributes);
    }

目前的结果

此刻感觉我迷失在迷宫中。我找不到解释max-backup-index属性和size-rotating-file-handler之间相互作用的代码。

Answer 1

你需要看看JBoss Log Manager而不是WildFly。 WildFly只是将所有内容委托给日志管理器。具体你要找的是this。

那说这是一个棘手的问题。没有一种可靠的方法来确定应删除哪些文件。使用日期后缀，您只能进行最佳猜测，这不是很好。您不希望日志轮换删除您有意尝试保存的文件。

比如说你有一个server.log.2015-01-01和一个server.log.2015-01-01.save。你怎么知道只删除第一个？我们不想删除第二个，因为它可能被用户重命名。

还有考虑的性能。在运行复杂文件匹配算法时，您不希望阻止。默认情况下，日志记录是阻止的，因此任何尝试记录的代码都将被阻止，直到轮换完成。

Answer 2

您可以将“periodic-size-rotating-file-handler”配置为：

1. 时间戳文件名（后缀）
2. 达到一定大小后旋转（旋转大小）
3. 达到一定数量的文件后删除最后一个文件（max-backup-index）

例如：

<periodic-size-rotating-file-handler name="FILE" autoflush="true">
    <formatter>
        <named-formatter name="PATTERN"/>
    </formatter>
    <file relative-to="jboss.server.log.dir" path="server.log"/>
    <suffix value=".yyyy-MM-dd"/>
    <max-backup-index value="10"/>
    <rotate-size value="5m"/>
    <append value="false"/>
</periodic-size-rotating-file-handler>