logback

一:根节点包含的属性:

scan:

当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。

scanPeriod:

设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。

debug:

当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。

例如:

Xml代码


二:根节点的子节点:

2.1设置上下文名称:

每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。

Xml代码

myAppName


2.2设置变量:

用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。

例如使用定义上下文名称,然后在设置logger上下文时使用。

Xml代码

${APP_Name}


2.3获取时间戳字符串:

两个属性 key:标识此的名字;datePattern:设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。

例如将解析配置文件的时间作为上下文名称:

Xml代码

${bySecond}


2.4设置loger:

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。仅有一个name属性,一个可选的level和一个可选的addtivity属性。

name:

用来指定受此loger约束的某一个包或者具体的某一个类。

level:

用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。

如果未设置此属性,那么当前loger将会继承上级的级别。

addtivity:

是否向上级loger传递打印信息。默认是true。

可以包含零个或多个元素,标识这个appender将会添加到这个loger。

也是元素,但是它是根loger。只有一个level属性,应为已经被命名为"root".

level:

用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。

默认是DEBUG。

可以包含零个或多个元素,标识这个appender将会添加到这个loger。

例如:

LogbackDemo.java类

Java代码

packagelogback;

importorg.slf4j.Logger;

importorg.slf4j.LoggerFactory;

publicclassLogbackDemo {

privatestaticLogger log = LoggerFactory.getLogger(LogbackDemo.class);

publicstaticvoidmain(String[] args) {

log.trace("======trace");

log.debug("======debug");

log.info("======info");

log.warn("======warn");

log.error("======error");

}

}

logback.xml配置文件

第1种:只配置root

Xml代码


%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

其中appender的配置表示打印到控制台(稍后详细讲解appender);

将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。

当执行logback.LogbackDemo类的main方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

打印结果如下:

Xml代码

13:30:38.484 [main] INFO  logback.LogbackDemo-======info

13:30:38.500 [main] WARN  logback.LogbackDemo-======warn

13:30:38.500 [main] ERROR logback.LogbackDemo-======error

第2种:带有loger的配置,不指定级别,不指定appender,

Xml代码


%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n


其中appender的配置表示打印到控制台(稍后详细讲解appender);

将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“DEBUG”;

没有设置addtivity,默认为true,将此loger的打印信息向上级传递;

没有设置appender,此loger本身不打印任何信息。

将root的打印级别设置为“DEBUG”,指定了名字为“STDOUT”的appender。

当执行logback.LogbackDemo类的main方法时,因为LogbackDemo 在包logback中,所以首先执行,将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root,本身并不打印;

root接到下级传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

打印结果如下:

Xml代码

13:19:15.406 [main] DEBUG logback.LogbackDemo-======debug

13:19:15.406 [main] INFO  logback.LogbackDemo-======info

13:19:15.406 [main] WARN  logback.LogbackDemo-======warn

13:19:15.406 [main] ERROR logback.LogbackDemo-======error

第3种:带有多个loger的配置,指定级别,指定appender

Xml代码


%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n



其中appender的配置表示打印到控制台(稍后详细讲解appender);

将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“DEBUG”;

没有设置addtivity,默认为true,将此loger的打印信息向上级传递;

没有设置appender,此loger本身不打印任何信息。

控制logback.LogbackDemo类的日志打印,打印级别为“INFO”;

additivity属性为false,表示此loger的打印信息不再向上级传递,

指定了名字为“STDOUT”的appender。

将root的打印级别设置为“ERROR”,指定了名字为“STDOUT”的appender。

当执行logback.LogbackDemo类的main方法时,先执行,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志,不再向次loger的上级 传递打印信息;

未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;

打印结果如下:

Xml代码

14:05:35.937 [main] INFO  logback.LogbackDemo-======info

14:05:35.937 [main] WARN  logback.LogbackDemo-======warn

14:05:35.937 [main] ERROR logback.LogbackDemo-======error

如果将修改为 那打印结果将是什么呢?

没错,日志打印了两次,想必大家都知道原因了,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次

打印结果如下:

Xml代码

14:09:01.531 [main] INFO  logback.LogbackDemo-======info

14:09:01.531 [main] INFO  logback.LogbackDemo-======info

14:09:01.531 [main] WARN  logback.LogbackDemo-======warn

14:09:01.531 [main] WARN  logback.LogbackDemo-======warn

14:09:01.531 [main] ERROR logback.LogbackDemo-======error

14:09:01.531 [main] ERROR logback.LogbackDemo-======error

***********************************************详解>******************************************

是的子节点,是负责写日志的组件。

有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。

1.ConsoleAppender:

把日志添加到控制台,有以下子节点:

:对日志进行格式化。(具体参数稍后讲解)

:字符串System.out或者System.err,默认System.out

例如:

Xml代码

%-4relative [%thread] %-5level %logger{35} - %msg %n

2.FileAppender:

把日志添加到文件,有以下子节点:

:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。

:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。

:对记录事件进行格式化。(具体参数稍后讲解)

:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。

例如:

Xml代码

testFile.log

true

%-4relative [%thread] %-5level %logger{35} - %msg%n

3.RollingFileAppender:

滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:

:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。

:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。

:对记录事件进行格式化。(具体参数稍后讲解)

:当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名。

>:告知RollingFileAppender合适激活滚动。

:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。

rollingPolicy:

TimeBasedRollingPolicy:最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:

:

必要节点,包含文件名及“%d”转换符,“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。

:

可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。

FixedWindowRollingPolicy:根据固定窗口算法重命名文件的滚动策略。有以下子节点:

:窗口索引最小值

:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。

:

必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip

triggeringPolicy:

SizeBasedTriggeringPolicy:查看当前活动文件的大小,如果超过指定大小会告知RollingFileAppender触发当前活动文件滚动。只有一个节点:

:这是活动文件的大小,默认值是10MB。

例如:每天生成一个日志文件,保存30天的日志文件。

Java代码

logFile.%d{yyyy-MM-dd}.log

30

%-4relative [%thread] %-5level %logger{35} - %msg%n

例如:按照固定窗口模式生成日志文件,当文件大于20MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。

Xml代码

test.log

tests.%i.log.zip

1

3

5MB

%-4relative [%thread] %-5level %logger{35} - %msg%n

4.另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,这些就不在这里讲解了,大家可以参考官方文档。当然大家可以编写自己的Appender。

负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。

目前PatternLayoutEncoder是唯一有用的且默认的encoder,有一个节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“\%”进行转义。

例如:

Xml代码

%-4relative [%thread] %-5level %logger{35} - %msg%n

里面的转换符说明:

转换符作用

c{length}lo{length}logger{length}输出日志的logger名,可有一个整形参数,功能是缩短logger名,设置为0表示只输入logger最右边点符号之后的字符串。

Conversion specifierLogger nameResult

%loggermainPackage.sub.sample.BarmainPackage.sub.sample.Bar

%logger{0}mainPackage.sub.sample.BarBar

%logger{5}mainPackage.sub.sample.Barm.s.s.Bar

%logger{10}mainPackage.sub.sample.Barm.s.s.Bar

%logger{15}mainPackage.sub.sample.Barm.s.sample.Bar

%logger{16}mainPackage.sub.sample.Barm.sub.sample.Bar

%logger{26}mainPackage.sub.sample.BarmainPackage.sub.sample.Bar

C{length}class{length}输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用,除非执行速度不造成任何问题。

contextNamecn输出上下文名称。

d{pattern}date{pattern}输出日志的打印日志,模式语法与java.text.SimpleDateFormat兼容。

Conversion PatternResult

%d2006-10-20 14:06:49,812

%date2006-10-20 14:06:49,812

%date{ISO8601}2006-10-20 14:06:49,812

%date{HH:mm:ss.SSS}14:06:49.812

%date{dd MMM yyyy ;HH:mm:ss.SSS}20 oct. 2006;14:06:49.812

F / file输出执行记录请求的java源文件名。尽量避免使用,除非执行速度不造成任何问题。

caller{depth}caller{depth, evaluator-1, ... evaluator-n}输出生成日志的调用者的位置信息,整数选项表示输出信息深度。

例如,%caller{2}输出为:

0[main]DEBUG-loggingstatementCaller+0atmainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)Caller+1atmainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)

例如,%caller{3}输出为:

16[main]DEBUG-loggingstatementCaller+0atmainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)Caller+1atmainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)Caller+2atmainPackage.ConfigTester.main(ConfigTester.java:38)

L / line输出执行日志请求的行号。尽量避免使用,除非执行速度不造成任何问题。

m / msg / message输出应用程序提供的信息。

M / method输出执行日志请求的方法名。尽量避免使用,除非执行速度不造成任何问题。

n输出平台先关的分行符“\n”或者“\r\n”。

p / le / level输出日志级别。

r / relative输出从程序启动到创建日志记录的时间,单位是毫秒

t / thread输出产生日志的线程名。

replace(p){r, t}p为日志内容,r是正则表达式,将p中符合r的内容替换为t

例如, "%replace(%msg){'\s', ''}"

格式修饰符,与转换符共同使用:

可选的格式修饰符位于“%”和转换符之间。

第一个可选修饰符是左对齐标志,符号是减号“-”;接着是可选的最小宽度修饰符,用十进制数表示。如果字符小于最小宽度,则左填充或右填充,默认是左填充(即右对齐),填充符为空格。如果字符大于最小宽度,字符永远不会被截断。最大宽度修饰符,符号是点号"."后面加十进制数。如果字符大于最大宽度,则从前面截断。点符号“.”后面加减号“-”在加数字,表示从尾部截断。

例如:%-4relative 表示,将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。

***********************************************详解*****************************************

:

过滤器,执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一。返回DENY,日志将立即被抛弃不再经过其他过滤器;返回NEUTRAL,有序列表里的下个过滤器过接着处理日志;返回ACCEPT,日志会被立即处理,不再经过剩余过滤器。

过滤器被添加到中,为添加一个或多个过滤器后,可以用任意条件对日志进行过滤。有多个过滤器时,按照配置顺序执行。

下面是几个常用的过滤器:

LevelFilter:级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。有以下子节点:

:设置过滤级别

:用于配置符合过滤条件的操作

:用于配置不符合过滤条件的操作

例如:将过滤器的日志级别配置为INFO,所有INFO级别的日志交给appender处理,非INFO级别的日志,被过滤掉。

Xml代码

INFO

ACCEPT

DENY

%-4relative [%thread] %-5level %logger{30} - %msg%n

ThresholdFilter:临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。

例如:过滤掉所有低于INFO级别的日志。

Xml代码

class="ch.qos.logback.core.ConsoleAppender">


INFO

%-4relative [%thread] %-5level %logger{30} - %msg%n

EvaluatorFilter:求值过滤器,评估、鉴别日志是否符合指定条件。有一下子节点:

:

鉴别器,常用的鉴别器是JaninoEventEvaluato,也是默认的鉴别器,它以任意的java布尔值表达式作为求值条件,求值条件在配置文件解释过成功被动态编译,布尔值表达式返回true就表示符合过滤条件。evaluator有个子标签,用于配置求值条件。

求值表达式作用于当前日志,logback向求值表达式暴露日志的各种字段:

NameTypeDescription

eventLoggingEvent与记录请求相关联的原始记录事件,下面所有变量都来自event,例如,event.getMessage()返回下面"message"相同的字符串

messageString日志的原始消息,例如,设有logger mylogger,"name"的值是"AUB",对于 mylogger.info("Hello {}",name); "Hello {}"就是原始消息。

formatedMessageString日志被各式话的消息,例如,设有logger mylogger,"name"的值是"AUB",对于 mylogger.info("Hello {}",name); "Hello Aub"就是格式化后的消息。

loggerStringlogger 名。

loggerContextLoggerContextVO日志所属的logger上下文。

levelint级别对应的整数值,所以level > INFO是正确的表达式。

timeStamplong创建日志的时间戳。

markerMarker与日志请求相关联的Marker对象,注意“Marker”有可能为null,所以你要确保它不能是null。

mdcMap包含创建日志期间的MDC所有值得map。访问方法是:mdc.get("myKey")。mdc.get()返回的是Object不是String,要想调用String的方法就要强转,例如,

((String) mdc.get("k")).contains("val") .MDC可能为null,调用时注意。

throwablejava.lang.Throwable如果没有异常与日志关联"throwable" 变量为 null. 不幸的是, "throwable" 不能被序列化。在远程系统上永远为null,对于与位置无关的表达式请使用下面的变量throwableProxy

throwableProxyIThrowableProxy与日志事件关联的异常代理。如果没有异常与日志事件关联,则变量"throwableProxy" 为 null. 当异常被关联到日志事件时,"throwableProxy" 在远程系统上不会为null

:用于配置符合过滤条件的操作

:用于配置不符合过滤条件的操作

例如:过滤掉所有日志消息中不包含“billing”字符串的日志。

Xml代码

return message.contains("billing");

ACCEPT

DENY

%-4relative [%thread] %-5level %logger - %msg%n

匹配器,尽管可以使用String类的matches()方法进行模式匹配,但会导致每次调用过滤器时都会创建一个新的Pattern对象,为了消除这种开销,可以预定义一个或多个matcher对象,定以后就可以在求值表达式中重复引用。是的子标签。

中包含两个子标签,一个是,用于定义matcher的名字,求值表达式中使用这个名字来引用matcher;另一个是,用于配置匹配条件。

例如:

Xml代码

odd


statement [13579]

odd.matches(formattedMessage)

NEUTRAL

DENY

%-4relative [%thread] %-5level %logger - %msg%n

其他Filter不太常用了,大家可以参见官网。


原文:http://my.oschina.net/arlin/blog/519731

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266

推荐阅读更多精彩内容