ما هو إطار عمل التسجيل Logback.xml؟ مثال ConsoleAppender و FileAppender و RollingFileAppender

نشرت: 2019-02-13
ما هو إطار عمل التسجيل Logback.xml؟ ConsoleAppender و FileAppender و RollingFileAppender البرنامج التعليمي

هل أنت على علم Logback Logging Framework ؟ حسنًا ، يستخدم معظم الأشخاص بشكل أساسي log4j and slf4j في مشروعهم. منذ 6 أشهر الماضية ، كنت أستخدم إطار عمل التسجيل Logback.xml وأود أن أقول إنني رأيت بعض التحسينات في الأداء في تطبيق الإنتاج الخاص بي.

في هذا البرنامج التعليمي سوف ننتقل إلى مثال عملي لإطار عمل تسجيل الدخول Logback.

ما هو logback.qos.ch؟

Logback هو نوع من الإصدار الجديد من Log4j. تم تطويره من حيث توقف تطوير log4j.

تفاصيل إطار عمل تسجيل الدخول

في Crunchify ، قمنا بنشر العديد من البرامج التعليمية على Log4j إذا كنت مهتمًا:

  • كيفية إعداد مستوى تسجيل log4j الخاص بك؟
  • كيف يتم تكوين log4j.properties؟

سننتقل هنا إلى جميع الخطوات التفصيلية حول كيفية إعداد Logback Logging Framework لمشروع Java Enterprise الخاص بك. سنقوم بإنشاء ملفات جديدة أدناه.

  1. ضمن مجلد الموارد ، ملف logback.xml
  2. فئة جافا CrunchifyLogbackLogging.java

هيا بنا نبدأ

الخطوة 1 قم بإنشاء ملف logback.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 أولاً.

  • في الجزء السفلي من الملف ، ترى أن لدينا 3 مراجع appender-ref ضمن عنصر root .
  • نحن نستخدم مستوى السجل كـ DEBUG . هذا يعني طباعة كل شيء بمستوى DEBUG وما فوق.

CRUNCHIFYOUT من الفئة ch.qos.logback.core. ConsoleAppender . مما يعني أنه ستتم طباعة جميع بيانات التسجيل على وحدة تحكم Eclipse.

CRUNCHIFYFILE من النوع ch.qos.logback.core. FileAppender . هذا يعني أنه سيتم أيضًا طباعة جميع بيانات التسجيل إلى ملف محلي. في حالتنا هو / Users / ashah / Documents / crunchify.log .

CRUNCHIFYROLLING من النوع ch.qos.logback.core.rolling. RollingFileAppender . كما ترى في rollingPolicy ، نحن نلف الملف كل يوم ونحتفظ بحد أقصى 10 ملفات. أيضًا ، هناك حد إجمالي لسعة الملف وهو 1 GB في مثالنا. سيتم إنشاء ملف جديد في location / Users / ashah / Documents / crunchify -rolling.log .

الخطوة 2 اكتب برنامج 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
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......" ) ;
}
 
}
}

هذه فئة اختبار جافا بسيطة للغاية ، حيث نستخدم الخطأ والمعلومات وتصحيح الأخطاء والتحذير لجميع مستويات التسجيل الأربعة. نحن نجري حلقات من خلال 10 مرات.

الخطوه 3

بمجرد تشغيل البرنامج أعلاه ، سيقوم logback framework بإنشاء ملفين جديدين كما هو مذكور أعلاه.

تحقق من Eclipse Console الخاص بك. سترى أدناه السجلات:

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 وجميع الملاحق الثلاثة بشكل صحيح: ConsoleAppender ، FileAppender ، RollingFileAppender.

نقطة إضافية:

هل تريد إعداد RollingFileAppender باستخدام FixedWindowRollingPolicy ؟ حسنًا ، استخدم الملحق أدناه وضعه في ملف 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" / >