如何仅记录一次重复警告

Question

有一种模式时常发生。我有一个方法被调用了很多次，它包含这个片段：

Foo foo = getConfiguredFoo();
if (foo == null) {
  logger.warn("Foo not configured");
  foo = getDefaultFoo();
}

然后我的日志文件被这个警告弄乱了一百次。我知道我可以grep它，但我想知道是否有更好的方法来只看到这个警告一次。

注意：默认情况下，消息重复是正确的行为，因此这与 避免无意的重复日志消息。我将我的问题标记为 log4j，但我对其他 java 日志框架持开放态度。

Answer 1

这是我能想到的：一个累积警告的类，可以在最后转储这些警告。这是很常规的，但你可以明白要点。当然，可以自定义转储部分以使用记录器。

class BadNews {
  static Map<String,List<Object>> warnings = [:];

  static void warn(String key, Object uniqueStuff) {
    def knownWarnings = warnings[key]
    if (! knownWarnings) {
      knownWarnings = []
      warnings[key] = knownWarnings
    }
    knownWarnings << uniqueStuff
  }

  static void dumpWarnings(PrintStream out) {
    warnings.each{key, stuffs ->
      out.println("$key: " + stuffs.size())
      stuffs.each{
        out.println("\t$it")
      }
    }
  }
}

class SomewhereElse {
  def foo(Bar bar) {
    if (! bar)
      BadNews.warn("Empty bar", this)
  }
}

Answer 2

我不久前遇到过类似的问题，但在 Log4J 中找不到任何处理此问题的方法。
我最终做了以下操作：

Foo foo = getConfiguredFoo();
if (foo == null) {
  if(!warningLogged)logger.warn("Foo not configured");
  warningLogged = true
  foo = getDefaultFoo();
}

如果您有一两个日志语句，您不想在日志中看到重复，但又不想用更多日志语句进行扩展（您需要为每条记录的消息提供一个布尔值），则此解决方案是可以的

Answer 3

您可以在日志记录周围编写一个包装器来存储记录的最后一行。根据您的实现方式，您可以添加某种计数器来记录记录的次数，或者您可以选择子类化 Logger 而不是使用外部包装器。如果您也需要的话，可以使用布尔抑制重复进行配置。

public class LogWrapper{
    Logger logger = Logger.getLogger("your logger here");
    String lastLine = new String();

    public void warn(String s){
        if (lastLine.compareToIgnoreCase(s) == 0)
            return;
        else {
            lastLine = s;
            logger.warn(s);
        }
    }
}

Answer 4

如果这是您想要打印一次的唯一内容，那么使用保存的布尔值将是您最好的选择。如果您想要可以在整个项目中使用的东西，我已经创建了一些可能有用的东西。我刚刚创建了一个使用 log4j 记录器实例的 Java 类。当我想记录一条消息时，我只需执行以下操作：

LogConsolidated.log(logger, Level.WARN, 5000, "File: " + f + " not found.", e);

而不是：

logger.warn("File: " + f + " not found.", e);

这使得它每 5 秒最多记录 1 次，并打印它应该记录的次数（例如 |x53|）。显然，您可以这样做，这样您就没有那么多参数，或者通过执行 log.warn 或其他操作来拉出级别，但这适用于我的用例。

对于您来说（如果您只想每次打印一次），这有点过分了，但您仍然可以通过传入类似以下内容来实现：Long.MAX_LONG 作为第三个参数。我喜欢能够确定每个特定日志消息的频率（因此是参数）的灵活性。例如，这将实现您想要的：

LogConsolidated.log(logger, Level.WARN, Long.MAX_LONG, "File: " + f + " not found.", e);

这是 LogConsolidated 类：

import java.util.HashMap;

import org.apache.log4j.Level;
import org.apache.log4j.Logger;

public class LogConsolidated {

    private static HashMap<String, TimeAndCount> lastLoggedTime = new HashMap<>();

    /**
     * Logs given <code>message</code> to given <code>logger</code> as long as:
     * <ul>
     * <li>A message (from same class and line number) has not already been logged within the past <code>timeBetweenLogs</code>.</li>
     * <li>The given <code>level</code> is active for given <code>logger</code>.</li>
     * </ul>
     * Note: If messages are skipped, they are counted. When <code>timeBetweenLogs</code> has passed, and a repeat message is logged, 
     * the count will be displayed.
     * @param logger Where to log.
     * @param level Level to log.
     * @param timeBetweenLogs Milliseconds to wait between similar log messages.
     * @param message The actual message to log.
     * @param t Can be null. Will log stack trace if not null.
     */
    public static void log(Logger logger, Level level, long timeBetweenLogs, String message, Throwable t) {
        if (logger.isEnabledFor(level)) {
            String uniqueIdentifier = getFileAndLine();
            TimeAndCount lastTimeAndCount = lastLoggedTime.get(uniqueIdentifier);
            if (lastTimeAndCount != null) {
                synchronized (lastTimeAndCount) {
                    long now = System.currentTimeMillis();
                    if (now - lastTimeAndCount.time < timeBetweenLogs) {
                        lastTimeAndCount.count++;
                        return;
                    } else {
                        log(logger, level, "|x" + lastTimeAndCount.count + "| " + message, t);
                    }
                }
            } else {
                log(logger, level, message, t);
            }
            lastLoggedTime.put(uniqueIdentifier, new TimeAndCount());
        }
    }

    private static String getFileAndLine() {
        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
        boolean enteredLogConsolidated = false;
        for (StackTraceElement ste : stackTrace) {
            if (ste.getClassName().equals(LogConsolidated.class.getName())) {
                enteredLogConsolidated = true;
            } else if (enteredLogConsolidated) {
                // We have now file/line before entering LogConsolidated.
                return ste.getFileName() + ":" + ste.getLineNumber();
            }
        }
        return "?";
    }       

    private static void log(Logger logger, Level level, String message, Throwable t) {
        if (t == null) {
            logger.log(level, message);
        } else {
            logger.log(level, message, t);
        }
    }

    private static class TimeAndCount {
        long time;
        int count;
        TimeAndCount() {
            this.time = System.currentTimeMillis();
            this.count = 0;
        }
    }
}