log4j: ¿Forma estándar de evitar mensajes de registro repetitivos?

Question

Nuestra aplicación de producción registra un error cuando no puede establecer una conexión TCP/IP. Como está constantemente reintentando la conexión, registra el mismo mensaje de error una y otra vez. Y de manera similar, otros componentes en ejecución en la aplicación pueden entrar en un bucle de error si algún recurso en tiempo real no está disponible durante un período de tiempo.

¿Existe algún método estándar para controlar el número de veces que se registra el mismo error? (Estamos usando log4j, entonces si hay alguna extensión para log4j para manejar esto, sería perfecto.)

Answer 1

Sería bastante simple controlar esto registrando una marca de tiempo cada vez que registra el error, y luego solo registrándolo la próxima vez si ha transcurrido un cierto período.

ideal sería que esto sería una característica dentro log4j, pero la codificación dentro de su aplicación no es tan malo, y usted puede encapsular dentro de una clase de ayuda para evitar repetitivo a lo largo de su código.

Claramente, cada instrucción de registro repetitivo necesitaría algún tipo de ID única para que pueda fusionar declaraciones de la misma fuente.

Answer 2

Acabo de crear una clase de Java que resuelva este problema exacto usando log4j. Cuando quiero registrar un mensaje, acabo de hacer algo como esto:

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

En lugar de:

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

que hace que sea ingrese un máximo de 1 vez en la historia de 5 segundos, e imprime el número de veces debería haberse registrado (por ejemplo | x53 |). Obviamente, puede hacerlo para que no tenga tantos parámetros, o eliminar el nivel haciendo log.warn o algo así, pero esto funciona para mi caso de uso.

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; 
     } 
    } 
}