Uso de MDC en log4j para asignar un nombre dinámico al archivo de registro

Question

¿Es posible cómo usar MDC para nombrar el archivo de registro en tiempo de ejecución?

Tengo una sola aplicación web a la que se llaman con diferentes nombres al mismo tiempo usando tomcat docbase. Entonces necesito tener archivos de registro separados para cada uno de ellos.

Answer 1

Esto se puede lograr en Logback, el sucesor de Log4J.

Logback está diseñado como un sucesor del popular proyecto log4j, retomando donde lo deja log4j.

consulte la documentación de Sifting Appender

El SiftingAppender es único en su capacidad para hacer referencia y configurar appenders anidados. En el ejemplo anterior, dentro de SiftingAppender habrá instancias FileAppender anidadas, cada instancia identificada por el valor asociado con la clave MDC "ID de usuario". Siempre que a la clave MDC "userid" se le asigne un nuevo valor, se generará una nueva instancia de FileAppender desde cero. SiftingAppender realiza un seguimiento de los apéndices que crea. Los apéndices que no se usen durante 30 minutos se cerrarán automáticamente y se descartarán.

En el ejemplo, generan un archivo de registro separado para cada usuario basado en un valor de MDC. Se pueden usar otros valores de MDC según sus necesidades.

Answer 2

Esto también es posible con log4j. Puedes hacer esto implementando tu propio appender. Supongo que la forma más fácil es subclase AppenderSkeleton.

Todos los eventos de registro terminan en el método append(LoggingEvent event) que debe implementar.

En ese método se puede acceder al MDC por event.getMDC("nameOfTheKeyToLookFor");

A continuación, puede utilizar esta información para abrir el archivo para escribir. Puede ser útil echar un vistazo a la implementación de los appenders estándar como RollingFileAppender para descubrir el resto.

Utilicé este enfoque yo mismo en una aplicación para separar los registros de diferentes subprocesos en diferentes archivos de registro y funcionó muy bien.

Answer 3

Luché por un tiempo para encontrar la funcionalidad de SiftingAppender en log4j (no pudimos cambiar a logback debido a algunas dependencias), y terminé con una solución programática que funciona bastante bien, usando un MDC y agregando loggers en tiempo de ejecución:

// this can be any thread-specific string 
String processID = request.getProcessID(); 

Logger logger = Logger.getRootLogger(); 

// append a new file logger if no logger exists for this tag 
if(logger.getAppender(processID) == null){ 

    try{ 
    String pattern = "%d{yy/MM/dd HH:mm:ss} %p %c{2}: %m%n"; 
    String logfile = "log/"+processID+".log"; 

    FileAppender fileAppender = new FileAppender(
     new PatternLayout(pattern), logfile, true); 
    fileAppender.setName(processID); 

    // add a filter so we can ignore any logs from other threads 
    fileAppender.addFilter(new ProcessIDFilter(processID)); 

    logger.addAppender(fileAppender); 
    }catch(Exception e){ 
    throw new RuntimeException(e); 
    } 
} 

// tag all child threads with this process-id so we can separate out log output 
MDC.put("process-id", processID); 

//whatever you want to do in the thread 
LOG.info("This message will only end up in "+processID+".log!"); 

MDC.remove("process-id"); 

El filtro anexa anteriormente simplemente comprueba para un ID de proceso específico:

public class RunIdFilter extends Filter { 

    private final String runId; 

    public RunIdFilter(String runId) { 
    this.runId = runId; 
    } 

    @Override 
    public int decide(LoggingEvent event) { 
    Object mdc = event.getMDC("run-id"); 

    if (runId.equals(mdc)) { 
     return Filter.ACCEPT; 
    } 

    return Filter.DENY; 
    } 
} 

Hope esto ayuda un poco.