Logback.xmlロギングフレームワークとは何ですか？ ConsoleAppender、FileAppender、RollingFileAppenderの例

公開: 2019-02-13
Logback.xmlロギングフレームワークとは何ですか？ ConsoleAppender、FileAppender、RollingFileAppenderチュートリアル

Logback Logging Frameworkをご存知ですか？ さて、ほとんどの人は主にlog4j and slf4jをプロジェクトに使用しています。 過去6か月以来、 Logback.xmlロギングフレームワークを使用してきましたが、本番アプリケーションでかなりのパフォーマンスの向上が見られたと思います。

このチュートリアルでは、ログバックロギングフレームワークの実際の例について説明します。

logback.qos.chとは何ですか？

Logbackは、Log4jの新しいバージョンの一種です。 log4jの開発が止まったところから開発されました。

ログバックロギングフレームワークの詳細

Crunchifyでは、興味があればLog4jで複数のチュートリアルを公開しています。

  • 独自のlog4jログレベルを設定するにはどうすればよいですか？
  • log4j.propertiesを設定する方法は？

ここでは、エンタープライズJavaプロジェクトのログバックロギングフレームワークをセットアップする方法に関するすべての詳細な手順について説明します。 以下の新しいファイルを作成します。

  1. リソースフォルダlogback.xmlファイルの下
  2. JavaクラスCrunchifyLogbackLogging.java

始めましょう

ステップ-1logback.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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<? xml version = "1.0" encoding = "UTF-8" ?>
< configuration >
 
< appender name = "CRUNCHIFYOUT" class = "ch.qos.logback.core.ConsoleAppender" >
< layout class = "ch.qos.logback.classic.PatternLayout" >
< Pattern > % d { HH : mm : ss . SSS } [ % thread ] % - 5level % logger { 36 }
% X { sourceThread } - % msg % n < / Pattern >
< / layout >
< / appender >
 
< appender name = "CRUNCHIFYFILE" class = "ch.qos.logback.core.FileAppender" >
< file > / Users / ashah / Documents / crunchify . log < / file >
 
< encoder >
< pattern > % date % level [ % thread ] % logger { 10 } [ % file : % line ] % msg % n < / pattern >
< / encoder >
< / appender >
 
< appender name = "CRUNCHIFYROLLING" class = "ch.qos.logback.core.rolling.RollingFileAppender" >
< file > / Users / ashah / Documents / crunchify - rolling . log < / file >
 
< encoder class = "ch.qos.logback.classic.encoder.PatternLayoutEncoder" >
< Pattern >
% d { yyyy - MM - dd HH : mm : ss } [ % thread ] % level % logger { 35 } - % msg % n
< / Pattern >
< / encoder >
 
< rollingPolicy class = "ch.qos.logback.core.rolling.TimeBasedRollingPolicy" >
< ! -- We are rolling over daily -- >
< fileNamePattern > crunchify . log . timeroll . % d { yyyy - MM - dd } . log < / fileNamePattern >
 
< ! -- keep 10 days ' worth of history capped at 1GB total size -- >
< maxHistory > 10 < / maxHistory >
< totalSizeCap > 1GB < / totalSizeCap >
 
< / rollingPolicy >
< / appender >
 
< ! -- default is DEBUG -- >
< root level = "DEBUG" >
< appender - ref ref = "CRUNCHIFYOUT" / >
< appender - ref ref = "CRUNCHIFYFILE" / >
< appender - ref ref = "CRUNCHIFYROLLING" / >
< / root >
 
< / configuration >

最初にlogback.xmlファイルを理解しましょう。

  • ファイルの下部に、 root要素の下に3つのアペンダー参照appender-refがあることがわかります。
  • DEBUGとしてログレベルを使用しています。 つまり、レベルDEBUG以上ですべてを印刷します。

CRUNCHIFYOUTはクラスch.qos.logback.coreです。 ConsoleAppender 。 つまり、すべてのログデータがEclipseコンソールに出力されます。

CRUNCHIFYFILEのタイプはch.qos.logback.coreです。 FileAppender 。 つまり、すべてのログデータもlocalfileに出力されます。 この場合、それは/ Users / ashah / Documents crunchify.logです。

CRUNCHIFYROLLINGのタイプはch.qos.logback.core.rollingです。 RollingFileAppender 。 RollingPolicyに見られるように、私たちは毎日ファイルをローリングし、最大10個のファイルを保持しています。 また、この例では1 GBの合計ファイルサイズ容量制限があります。 新しいファイルは、場所/ Users / ashah / Documents / crunchify -rolling.logに作成されます。

ステップ-2Javaプログラムを作成してテストします。

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
package crunchify . com . tutorial ;
 
import org . slf4j . Logger ;
import org . slf4j . LoggerFactory ;
 
/**
* @author Crunchify.com
* Program: Very simple Logback.xml test class with ConsoleAppender, FileAppender and RollingFileAppender
* Version: 1.0.0
*
*/
 
public class CrunchifyLogbackLogging {
 
private final Logger crunchifyLogging = LoggerFactory . getLogger ( CrunchifyLogbackLogging . class ) ;
 
public static void main ( String [ ] args ) {
 
CrunchifyLogbackLogging crunchifyLogger = new CrunchifyLogbackLogging ( ) ;
crunchifyLogger . getStartedwithLogBackTesting ( ) ;
 
}
 
private void getStartedwithLogBackTesting ( ) {
 
for ( int i = 1 ; i < = 10 ; i ++ ) {
crunchifyLogging . debug ( "......This is test by Crunchify on Logback DEBUG...... " ) ;
crunchifyLogging . info ( "......This is test by Crunchify on Logback INFO......" ) ;
crunchifyLogging . error ( "......This is test by Crunchify on Logback ERROR......" ) ;
crunchifyLogging . warn ( "......This is test by Crunchify on Logback WARN......" ) ;
}
 
}
}

これは非常に単純なJavaテストクラスであり、エラー、情報、デバッグを使用して、4つのログレベルすべてに警告します。 10回ループしています。

ステップ-3

上記のプログラムを実行すると、logbackフレームワークは上記のように2つの新しいファイルを作成します。

Eclipseコンソールをチェックアウトします。 以下のログが表示されます。

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
15 : 36 : 12 , 978 | - INFO in ch . qos . logback . classic . LoggerContext [ default ] - Could NOT find resource [ logback - test . xml ]
15 : 36 : 12 , 978 | - INFO in ch . qos . logback . classic . LoggerContext [ default ] - Could NOT find resource [ logback . groovy ]
15 : 36 : 12 , 978 | - INFO in ch . qos . logback . classic . LoggerContext [ default ] - Found resource [ logback . xml ] at [ file : / Users / ashah / Documents / site / Bitbucket / crunchifytutorials / target / classes / logback . xml ]
15 : 36 : 13 , 077 | - INFO in ch . qos . logback . classic . joran . action . ConfigurationAction - debug attribute not set
15 : 36 : 13 , 077 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - About to instantiate appender of type [ ch . qos . logback . core . ConsoleAppender ]
15 : 36 : 13 , 087 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - Naming appender as [ CRUNCHIFYOUT ]
15 : 36 : 13 , 143 | - WARN in ch . qos . logback . core . ConsoleAppender [ CRUNCHIFYOUT ] - This appender no longer admits a layout as a sub - component , set an encoder instead .
15 : 36 : 13 , 143 | - WARN in ch . qos . logback . core . ConsoleAppender [ CRUNCHIFYOUT ] - To ensure compatibility , wrapping your layout in LayoutWrappingEncoder .
15 : 36 : 13 , 143 | - WARN in ch . qos . logback . core . ConsoleAppender [ CRUNCHIFYOUT ] - See also http : //logback.qos.ch/codes.html#layoutInsteadOfEncoder for details
15 : 36 : 13 , 144 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - About to instantiate appender of type [ ch . qos . logback . core . FileAppender ]
15 : 36 : 13 , 147 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - Naming appender as [ CRUNCHIFYFILE ]
15 : 36 : 13 , 147 | - INFO in ch . qos . logback . core . joran . action . NestedComplexPropertyIA - Assuming default type [ ch . qos . logback . classic . encoder . PatternLayoutEncoder ] for [ encoder ] property
15 : 36 : 13 , 148 | - INFO in ch . qos . logback . core . FileAppender [ CRUNCHIFYFILE ] - File property is set to [ / Users / ashah / Documents / crunchify . log ]
15 : 36 : 13 , 151 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - About to instantiate appender of type [ ch . qos . logback . core . rolling . RollingFileAppender ]
15 : 36 : 13 , 152 | - INFO in ch . qos . logback . core . joran . action . AppenderAction - Naming appender as [ CRUNCHIFYROLLING ]
15 : 36 : 13 , 159 | - INFO in c . q . l . core . rolling . TimeBasedRollingPolicy @ 2096171631 - setting totalSizeCap to 1 GB
15 : 36 : 13 , 161 | - INFO in c . q . l . core . rolling . TimeBasedRollingPolicy @ 2096171631 - No compression will be used
15 : 36 : 13 , 163 | - INFO in c . q . l . core . rolling . TimeBasedRollingPolicy @ 2096171631 - Will use the pattern crunchify . log . timeroll . % d { yyyy - MM - dd } . log for the active file
15 : 36 : 13 , 166 | - INFO in c . q . l . core . rolling . DefaultTimeBasedFileNamingAndTriggeringPolicy - The date pattern is 'yyyy-MM-dd' from file name pattern 'crunchify.log.timeroll.%d{yyyy-MM-dd}.log' .
15 : 36 : 13 , 166 | - INFO in c . q . l . core . rolling . DefaultTimeBasedFileNamingAndTriggeringPolicy - Roll - over at midnight .
15 : 36 : 13 , 171 | - INFO in c . q . l . core . rolling . DefaultTimeBasedFileNamingAndTriggeringPolicy - Setting initial period to Thu Sep 07 11 : 42 : 27 CDT 2017
15 : 36 : 13 , 173 | - INFO in ch . qos . logback . core . rolling . RollingFileAppender [ CRUNCHIFYROLLING ] - Active log file name : / Users / ashah / Documents / crunchify - rolling . log
15 : 36 : 13 , 173 | - INFO in ch . qos . logback . core . rolling . RollingFileAppender [ CRUNCHIFYROLLING ] - File property is set to [ / Users / ashah / Documents / crunchify - rolling . log ]
15 : 36 : 13 , 173 | - INFO in ch . qos . logback . classic . joran . action . RootLoggerAction - Setting level of ROOT logger to DEBUG
15 : 36 : 13 , 174 | - INFO in ch . qos . logback . core . joran . action . AppenderRefAction - Attaching appender named [ CRUNCHIFYOUT ] to Logger [ ROOT ]
15 : 36 : 13 , 174 | - INFO in ch . qos . logback . core . joran . action . AppenderRefAction - Attaching appender named [ CRUNCHIFYFILE ] to Logger [ ROOT ]
15 : 36 : 13 , 174 | - INFO in ch . qos . logback . core . joran . action . AppenderRefAction - Attaching appender named [ CRUNCHIFYROLLING ] to Logger [ ROOT ]
15 : 36 : 13 , 174 | - INFO in ch . qos . logback . classic . joran . action . ConfigurationAction - End of configuration .
15 : 36 : 13 , 175 | - INFO in ch . qos . logback . classic . joran . JoranConfigurator @ 7e0babb1 - Registering current configuration as safe fallback point
 
15 : 36 : 13.181 [ main ] DEBUG c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback DEBUG . . . . . .
15 : 36 : 13.186 [ main ] INFO    c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback INFO . . . . . .
15 : 36 : 13.187 [ main ] ERROR c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback ERROR . . . . . .
15 : 36 : 13.187 [ main ] WARN    c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback WARN . . . . . .
15 : 36 : 13.188 [ main ] DEBUG c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback DEBUG . . . . . .
15 : 36 : 13.188 [ main ] INFO    c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback INFO . . . . . .
15 : 36 : 13.188 [ main ] ERROR c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback ERROR . . . . . .
15 : 36 : 13.188 [ main ] WARN    c . c . tutorial . CrunchifyLogbackLogging
- . . . . . . This is test by Crunchify on Logback WARN . . . . . .

それに加えて、ローカルファイルログを確認することもできます。ご覧のとおり、 logback.xmlファイルはすべての新しいファイルを作成し、その中にログの印刷を開始しました。

Logback.xmlファイルは、新しいファイルアペンダーファイルを作成します

logback.xmlと3つのアペンダーすべて（ConsoleAppender、FileAppender、RollingFileAppender）が正しくセットアップされています。

ボーナスポイント：

FixedWindowRollingPolicy RollingFileAppender設定しますか？ 以下のアペンダーをよく使用して、logback.xmlファイルに入れてください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
< appender name = "CRUNCHIFYROLLINGFIXEDWINDOW" class = "ch.qos.logback.core.rolling.RollingFileAppender" >
     < file > / Users / ashah / Documents / crunchify - rolling - fixwindows . log < / file >
     < encoder class = "ch.qos.logback.classic.encoder.PatternLayoutEncoder" >
         < pattern > % date % level [ % thread ] % logger { 10 } [ % file : % line ] % msg % n < / pattern >
     < / encoder >
     < rollingPolicy class = "ch.qos.logback.core.rolling.FixedWindowRollingPolicy" >
         < FileNamePattern > crunchify . log . fixedsize . { yyyy - MM - dd } % i . log < / FileNamePattern >
         < MinIndex > 1 < / MinIndex >
         < MaxIndex > 15 < / MaxIndex >
     < / rollingPolicy >
     < triggeringPolicy class = "ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy" >
         < MaxFileSize > 20MB < / MaxFileSize >
     < / triggeringPolicy >
< / appender >

また、ルート要素の下にappender-refを追加するだけです。

1
< appender - ref ref = "CRUNCHIFYROLLINGFIXEDWINDOW" / >