Javaの場合Log4jを使用して独自のログレベルを作成する方法（Log4j 2の構成）

公開: 2017-07-26
Javaの場合Log4j2を使用して独自のログレベルを作成する方法

Log4jに独自のログレベルを追加する必要がある場合は、次のように行うことができます。 レベル、Apache Log4j2を使用したCustom Log Levels Level拡張する独自のクラスを作成する必要があります。

Log4jは、シンプルで柔軟なlogging frameworkです。 ロギングは、開発者にアプリケーション障害の詳細なコンテキストを提供します。 log4jを使用すると、アプリケーションバイナリを変更せずに、実行時にログを有効にすることができます。

log4jパッケージは、これらのステートメントが大きなパフォーマンスコストを発生させることなく、出荷されたコードに残ることができるように設計されています。

Log4jで独自のログレベルを作成する方法（Log4jの設定）

Log4jを使用すると、ログ要求を複数の宛先に出力できます。 log4jで言えば、出力先はappenderと呼ばれます。 それらは、コンソール、ファイル、GUIコンポーネント、リモートソケットサーバーからJMSまでさまざまです。

必要なjarファイル。

Mavenの依存関係は次のとおりです。

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

Log4jを最新バージョンに更新します

CVE-2021-44228：Apache Log4j2 <= 2.14.1構成、ログメッセージ、およびパラメーターで使用されるJNDI機能は、攻撃者が制御するLDAPおよびその他のJNDI関連のエンドポイントから保護しません。

log4j 2.16.0以降、この動作はデフォルトで無効になっています。

log4j.xmlファイルを/resourcesフォルダーに配置する必要があります。

リソースフォルダ内のlog4j.xmlファイル

以下のJavaコードのサンプルを次に示します。

  • JavaでのカスタムログレベルのLog4jロギング
  • log4jで独自のログレベルを作成する
  • 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 ) ;
     }
}

別の人は読む必要があります：

  • コマンドラインからApacheTomcatサーバーの停止を開始する方法は？ （Windowsサービスとしてのセットアップ）
  • Eclipseで単純なWebサービスとWebサービスクライアントを作成してデプロイする

これが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" ) ;
     }
}

テストプログラムを実行すると、 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

ログレベルに指定するint値は重要です。 ここで、「 CRUNCHIFY 」ログレベルはDEBUGレベルより高く、log4jによって提供されるTRACEレベルより低くなるように定義しました。

したがって、カテゴリ（ log4j.xmlファイル内）で優先度レベルをDEBUGに設定すると、 CRUNCHIFYレベルのログはログファイルに記録されません。