使用单个日志文件并删除旧日志文件的Logback FileAppender

Question

我使用在logback.groovy文件中配置的logback来管理我的应用程序的日志。我想：

1. 创建在应用程序启动时带有时间戳的日志文件，并在应用程序的整个生命周期中作为单个日志文件保留。(我们可能会让一个应用程序的多个实例同时运行，或者在一天中运行多个实例，它们可能会运行几天。)
2. 保持一个干净的日志文件目录，以便删除超过给定周期的日志

实现第一个建议使用FileAppender，如下所示-但是，这不会删除旧的日志文件：

appender("FILE", FileAppender) {
file = "path/to/log/dir/log_file_${date}.log"
}

实现第二个建议使用RollingFileAppender和TimeBasedRollingPolicy，如下所示，这将使日志文件保持7天。然而，无论应用程序何时运行，这都将使用一个文件来记录给定日期应用程序的所有实例：

appender("FILE", RollingFileAppender) {
rollingPolicy(TimeBasedRollingPolicy) {
fileNamePattern = "path/to/log/dir/log_file_%d{yyyyMMdd}.log"
maxHistory = 7;
}
}

我怎么能吃蛋糕呢？即，每次运行应用程序(带启动时间戳)都要获得一个日志文件的好处，但要获得RollingFileAppender/TimeBasedRollingPolicy的历史清理好处？

Answer 1

在可能有用的范围内，可以通过创建自定义FileAppender来实现这一点，如下所示：

public class TidyFileAppender<E> extends FileAppender<E> {
protected File directory;
@Override
public void start() {
if (conditions to determine historical files to be deleted) {
File[] oldFiles = directory.listFiles(new FileFilter() {
@Override
public boolean accept(File file) {
// return true if file is 'old'
}
});
if (oldFiles != null) {
for (File oldFile : oldFiles) {
if (!oldFile.delete()) {
addWarn("Failed to delete old log file: " + oldFile);
}
}
}
} else {
addWarn("Cannot tidy historical logs...");
}
super.start();
}
}

Answer 2

在前面的答案的基础上，这是一个具体且有效的Kotlin实现：

import ch.qos.logback.core.FileAppender
import java.io.File
class TidyFileAppender<E>: FileAppender<E>() {
/** Defaults to the parent dir of the current logfile. */
var directory: String? = null
/** How many previous files to keep, by last modified attribute. */
var maxHistory: Int = 20
/** Threshold for extra files that may be kept to reduce file system accesses. */
var threshold: Int = 0

override fun start() {
if (directory == null)
directory = File(fileName).parent
File(directory).list()?.let { files ->
if (files.size > maxHistory + threshold) {
files.map { File(directory, it) }
.sortedBy { it.lastModified() }
.take(files.size - maxHistory)
//.also { println("Removing $it") }
.forEach(File::delete)
}
}
super.start()
}
}

用法示例：

<timestamp key="time" datePattern="MM-dd'T'HHmm"/>
<appender name="FILE" class="TidyFileAppender">
<file>${LOG_DIRECTORY:-log}/game-server_${time}.log</file>
<maxHistory>15</maxHistory>
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>%d{HH:mm:ss} %-5level %36logger{36} - %msg%n</Pattern>
</layout>
</appender>