En Java Cómo crear su propio nivel de registro usando Log4j (Configuración de Log4j 2)

Publicado: 2017-07-26
En Java Cómo crear su propio nivel de registro usando Log4j 2

Si necesita agregar su propio nivel de registro en Log4j, puede hacerlo de la siguiente manera. Tendrá que crear su propia clase que se extenderá desde Level , Custom Log Levels con Apache Log4j 2.

Log4j es un logging framework simple y flexible. El registro proporciona al desarrollador un contexto detallado para las fallas de la aplicación. Con log4j es posible habilitar el registro en tiempo de ejecución sin modificar el binario de la aplicación.

El paquete log4j está diseñado para que estas declaraciones puedan permanecer en el código enviado sin incurrir en un alto costo de rendimiento.

Cómo crear su propio nivel de registro en Log4j (Configuración de Log4j)

Log4j permite registrar solicitudes para imprimir en múltiples destinos. En lenguaje log4j, un destino de salida se llama appender . Varían desde consola, archivos, componentes GUI, servidores de socket remotos hasta JMS.

Archivo Jar que necesita.

Aquí hay una dependencia de Maven:

1
2
3
4
5
< dependency >
< groupId > log4j < / groupId >
< artifactId > log4j < / artifactId >
< version > 2.16.0 < / version >
< / dependency >

Actualice Log4j a la última versión

CVE-2021-44228: Apache Log4j2 <= 2.14.1 Las características de JNDI utilizadas en la configuración, los mensajes de registro y los parámetros no protegen contra LDAP controlado por atacantes y otros puntos finales relacionados con JNDI.

A partir de log4j 2.16.0, este comportamiento se ha desactivado de forma predeterminada.

Debe colocar el archivo log4j.xml en la carpeta /resources :

archivo log4j.xml en la carpeta de recursos

Aquí hay un ejemplo de código Java para:

  • Registro de Log4j para niveles de registro personalizados en Java
  • Crear su propio nivel de registro en log4j
  • ejemplo de registrador personalizado log4j

CrunchifyLog4jLevel.java

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
package com . crunchify . tutorials ;
import org . apache . log4j . Level ;
 
/**
* @author Crunchify.com
*
*/
 
@SuppressWarnings ( "serial" )
public class CrunchifyLog4jLevel extends Level {
 
     /**
     * Value of CrunchifyLog4jLevel level. This value is lesser than DEBUG_INT and higher
     * than TRACE_INT}
     */
     public static final int CRUNCHIFY_INT = DEBUG_INT - 10 ;
 
     /**
     * Level representing my log level
     */
     public static final Level CRUNCHIFY = new CrunchifyLog4jLevel ( CRUNCHIFY_INT , "CRUNCHIFY" , 10 ) ;
 
     /**
     * Constructor
     */
     protected CrunchifyLog4jLevel ( int arg0 , String arg1 , int arg2 ) {
         super ( arg0 , arg1 , arg2 ) ;
 
     }
 
     /**
     * Checks whether logArgument is "CRUNCHIFY" level. If yes then returns
     * CRUNCHIFY}, else calls CrunchifyLog4jLevel#toLevel(String, Level) passing
     * it Level#DEBUG as the defaultLevel.
     */
     public static Level toLevel ( String logArgument ) {
         if ( logArgument ! = null && logArgument.toUpperCase().equals("CRUNCHIFY")) {
            return CRUNCHIFY;
         }
         return ( Level ) toLevel ( logArgument , Level . DEBUG ) ;
     }
 
     /**
     * Checks whether val is CrunchifyLog4jLevel#CRUNCHIFY_INT. If yes then
     * returns CrunchifyLog4jLevel#CRUNCHIFY, else calls
     * CrunchifyLog4jLevel#toLevel(int, Level) passing it Level#DEBUG as the
     * defaultLevel
     *
     */
     public static Level toLevel ( int val ) {
         if ( val == CRUNCHIFY_INT ) {
             return CRUNCHIFY ;
         }
         return ( Level ) toLevel ( val , Level . DEBUG ) ;
     }
 
     /**
     * Checks whether val is CrunchifyLog4jLevel#CRUNCHIFY_INT. If yes
     * then returns CrunchifyLog4jLevel#CRUNCHIFY, else calls Level#toLevel(int, org.apache.log4j.Level)
     *
     */
     public static Level toLevel ( int val , Level defaultLevel ) {
         if ( val == CRUNCHIFY_INT ) {
             return CRUNCHIFY ;
         }
         return Level . toLevel ( val , defaultLevel ) ;
     }
 
     /**
     * Checks whether logArgument is "CRUNCHIFY" level. If yes then returns
     * CrunchifyLog4jLevel#CRUNCHIFY, else calls
     * Level#toLevel(java.lang.String, org.apache.log4j.Level)
     *
     */
     public static Level toLevel ( String logArgument , Level defaultLevel ) {
         if ( logArgument ! = null && logArgument.toUpperCase().equals("CRUNCHIFY")) {
            return CRUNCHIFY;
         }
         return Level . toLevel ( logArgument , defaultLevel ) ;
     }
}

Otro debe leer:

  • ¿Cómo iniciar Stop Apache Tomcat Server a través de la línea de comandos? (Configurar como servicio de Windows)
  • Cree e implemente un servicio web simple y un cliente de servicio web en Eclipse

Aquí hay un contenido del archivo log4j.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<? xml version = "1.0" encoding = "UTF-8" ?>
< ! DOCTYPE log4j : configuration SYSTEM "log4j.dtd" >
< log4j : configuration xmlns : log4j = "http://jakarta.apache.org/log4j/"
     debug = "false" >
 
     < ! -- FILE Appender -- >
     < appender name = "FILE" class = "org.apache.log4j.FileAppender" >
         < param name = "File" value = "c:/crunchify.log" / >
         < param name = "Append" value = "false" / >
         < layout class = "org.apache.log4j.PatternLayout" >
             < param name = "ConversionPattern" value = "%t %-5p %c - %m%n" / >
         < / layout >
     < / appender >
 
     < ! -- CONSOLE Appender -- >
     < appender name = "CONSOLE" class = "org.apache.log4j.ConsoleAppender" >
         < layout class = "org.apache.log4j.PatternLayout" >
             < param name = "ConversionPattern" value = "%d{ISO8601} %-5p [%c{1}] %m%n" / >
         < / layout >
     < / appender >
 
     < ! -- Limit Category and Specify Priority -- >
     < category name = "com.crunchify" >
         < priority value = "CRUNCHIFY" class = "com.crunchify.tutorials.CrunchifyLog4jLevel" / >
         < appender - ref ref = "CONSOLE" / >
     < / category >
 
     < ! -- Setup the Root category -- >
     < root >
         < appender - ref ref = "CONSOLE" / >
     < / root >
< / log4j : configuration >

CrunchifyLog4jLevelTest.java

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package com . crunchify . tutorials ;
 
import org . apache . log4j . Level ;
import org . apache . log4j . Logger ;
import com . crunchify . tutorials . CrunchifyLog4jLevel ;
 
/**
* Tests whether the new log level
* com.crunchify.tutorials.CrunchifyLog4jLevel#CRUNCHIFY} is working
*
* @author Crunchify.com
*
*/
public class CrunchifyLog4jLevelTest {
 
     public static void main ( String [ ] args ) {
         Logger logger = Logger . getLogger ( CrunchifyLog4jLevelTest . class ) ;
         logger . log ( CrunchifyLog4jLevel . CRUNCHIFY , "I am CrunchifyLog4jLevelTest log" ) ;
         logger . log ( Level . DEBUG , "I am a DEBUG message" ) ;
     }
}

Ejecute el programa de prueba y debería ver el siguiente tipo de resultado en Eclipse's Console .

1
2
2013 - 08 - 01 15 : 22 : 36 , 758 CRUNCHIFY [ CrunchifyLog4jLevelTest ] I am CrunchifyLog4jLevelTest log
2013 - 08 - 01 15 : 22 : 36 , 758 DEBUG [ CrunchifyLog4jLevelTest ] I am a DEBUG message

El valor int que especifica para su nivel de registro es importante. Aquí he definido que el nivel de registro " CRUNCHIFY " debe ser superior al nivel DEBUG pero inferior al nivel TRACE proporcionado por log4j.

Entonces, siempre que haya establecido un nivel de prioridad para DEPURAR en la categoría (en su archivo log4j.xml ), los registros del nivel CRUNCHIFY NO llegarán al archivo de registro.