logback.xml常用配置详解(二)< appender > and <filter>

标签:
appenderlogbackfilterfilejava |
分类: 框架 |
(二)
是configuration的子节点,是负责写日志的组件。
appender有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。
1.ConsoleAppender:
把日志添加到控制台,有以下子节点:
encoder:对日志进行格式化。(具体参数稍后讲解
target:字符串
例如:
-
<</span>configuration>
-
-
<</span>appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> -
<</span>encoder> -
<</span>pattern>%-4relative [%thread] </</span>pattern>%-5level %logger{35} - %msg %n -
</</span>encoder> -
</</span>appender> -
<</span>root level="DEBUG"> -
<</span>appender-ref ref="STDOUT" /> -
</</span>root> -
</</span>configuration>
2.FileAppender:
把日志添加到文件,有以下子节点:
:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
:对记录事件进行格式化。(具体参数稍后讲解
:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
例如:
-
<</span>configuration>
-
-
<</span>appender name="FILE" class="ch.qos.logback.core.FileAppender"> -
<</span>file>testFile.log</</span>file> -
<</span>append>true</</span>append> -
<</span>encoder> -
<</span>pattern>%-4relative [%thread] </</span>pattern>%-5level %logger{35} - %msg%n -
</</span>encoder> -
</</span>appender> -
-
<</span>root level="DEBUG"> -
<</span>appender-ref ref="FILE" /> -
</</span>root> -
</</span>configuration>
3.RollingFileAppender:
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
:对记录事件进行格式化。(具体参数稍后讲解
:当发生滚动时,决定RollingFileAppender
<<span
class="option">triggeringPolicy
:当为true时,不支持FixedWindowRollingPolicy
rollingPolicy:
TimeBasedRollingPolicy:
<<span class="option">fileNamePattern>:
必要节点,包含文件名及“%d”转换符, java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。如果直接使用
%d,默认格式是
yyyy-MM-dd。
RollingFileAppender的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
<<span class="option">maxHistory>:
可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且<<span class="option">maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。
FixedWindowRollingPolicy
<<span class="option">minIndex>:窗口索引最小值
<<span class="option">maxIndex>:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
<<span
class="option">fileNamePattern
必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项,例如,mylog%i.log.gz 或者 没有log%i.log.zip
triggeringPolicy:
SizeBasedTriggeringPolic
:这是活动文件的大小,默认值是10MB。
例如:每天生成一个日志文件,保存30天的日志文件。
-
-
"FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> -
-
class -
logFile.%d{yyyy-MM-dd}.log -
30 -
-
-
-
%-4relative [%thread] %-5level %logger{35} - %msg%n -
-
-
-
"DEBUG"> -
"FILE" /> -
-
-
<</span>configuration>
-
<</span>appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"> -
<</span>file>test.log</</span>file> -
-
<</span>rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy " > -
<</span>fileNamePattern>tests.%i.log.zip</</span>fileNamePattern> -
<</span>minIndex>1</</span>minIndex> -
<</span>maxIndex>3</</span>maxIndex> -
</</span>rollingPolicy> -
-
<</span>triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolic y" > -
<</span>maxFileSize>5MB</</span>maxFileSize> -
</</span>triggeringPolicy> -
<</span>encoder> -
<</span>pattern>%-4relative [%thread] </</span>pattern>%-5level %logger{35} - %msg%n -
</</span>encoder> -
</</span>appender> -
-
<</span>root level="DEBUG"> -
<</span>appender-ref ref="FILE" /> -
</</span>root> -
</</span>configuration>
4.另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,这些就不在这里讲解了,大家可以参考官方文档。当然大家可以编写自己的Appender。
:
负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。
目前PatternLayoutEncoder
例如:
-
<</span>encoder>
-
<</span>pattern>%-4relative [%thread] </</span>pattern>%-5level %logger{35} - %msg%n -
</</span>encoder
里面的转换符说明:
转换符作用
c lo logger |
输出日志的logger名,可有一个整形参数,功能是缩短logger名,设置为0表示只输入logger最右边点符号之后的字符串。Conversion
specifierLogger nameResult
|
||||||||||||||||||||||
C class |
输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用,除非执行速度不造成任何问题。 | ||||||||||||||||||||||
contextName cn |
输出上下文名称。 | ||||||||||||||||||||||
d date |
输出日志的打印日志,模式语法与java.text.SimpleDateFormat
|
||||||||||||||||||||||
F / file | 输出执行记录请求的java源文件名。尽量避免使用,除非执行速度不造成任何问题。 | ||||||||||||||||||||||
caller{depth} caller{depth, evaluator-1, ... evaluator-n} | 输出生成日志的调用者的位置信息,整数选项表示输出信息深度。
例如, 0 [main] DEBUG - logging statement Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22) Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
例如, 16 [main] DEBUG - logging statement Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22) Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17) Caller+2 at mainPackage.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 |
p 例如, "%replace(%msg){'\s', ''}" |
格式修饰符,与转换符共同使用:
可选的格式修饰符位于“%”和转换符之间。
第一个可选修饰符是左对齐
例如:%-4relative 表示,将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4
(三)
:
过滤器,执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一。返回DENY,日志将立即被抛弃不再经过其他过滤器;返回NEUTRAL,有序列表里的下个过滤器过接着处理日志;返回ACCEPT,日志会被立即处理,不再经过剩余过滤器。
过滤器被添加到
下面是几个常用的过滤器:
LevelFilter:
level:设置过滤级别
onMatch:用于配置符合过滤条件的操作
onMismatch:用于配置不符合过滤条件的操作
例如:将过滤器的日志级别配置为INFO,所有INFO级别的日志交给appender处理,非INFO级别的日志,被过滤掉。
-
<</span>configuration>
-
<</span>appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> -
<</span>filter class="ch.qos.logback.classic.filter.LevelFilter"> -
<</span>level>INFO</</span>level> -
<</span>onMatch>ACCEPT</</span>onMatch> -
<</span>onMismatch>DENY</</span>onMismatch> -
</</span>filter> -
<</span>encoder> -
<</span>pattern> -
%-4relative [%thread] %-5level %logger{30} - %msg%n -
</</span>pattern> -
</</span>encoder> -
</</span>appender> -
<</span>root level="DEBUG"> -
<</span>appender-ref ref="CONSOLE" /> -
</</span>root> -
</</span>configuration>
ThresholdFilter:
例如:过滤掉所有低于INFO级别的日志。
-
<</span>configuration>
-
<</span>appender name="CONSOLE" -
class="ch.qos.logback.core.ConsoleAppender"> -
-
<</span>filter class="ch.qos.logback.classic.filter.ThresholdFilter"> -
<</span>level>INFO</</span>level> -
</</span>filter> -
<</span>encoder> -
<</span>pattern> -
%-4relative [%thread] %-5level %logger{30} - %msg%n -
</</span>pattern> -
</</span>encoder> -
</</span>appender> -
<</span>root level="DEBUG"> -
<</span>appender-ref ref="CONSOLE" /> -
</</span>root> -
</</span>configuration>
EvaluatorFilter:
:
鉴别器,常用的鉴别器是JaninoEventEvaluato,也是默认的鉴别器,它以任意的java布尔值表达式作为求值条件,求值条件在配置文件解释过成功被动态编译,布尔值表达式返回true就表示符合过滤条件。evaluator有个子标签,用于配置求值条件。
求值表达式作用于当前日志,logback向求值表达式暴露日志的各种字段:
NameTypeDescriptionevent | LoggingEvent |
与记录请求相关联的原始记录事件,下面所有变量都来自event,例如,event.getMessage()返回下面"message"相同的字符串 |
message | String |
日志的原始消息,例如,设有logger mylogger,"name"的值是"AUB",对于 mylogger.info("Hello {}",name); "Hello {}"就是原始消息。 |
formatedMessage | String |
日志被各式话的消息,例如,设有logger mylogger,"name"的值是"AUB",对于 mylogger.info("Hello {}",name); "Hello Aub"就是格式化后的消息。 |
logger | String |
logger 名。 |
loggerContext |
LoggerContextVO |
日志所属的logger上下文。 |
level | int |
级别对应的整数值,所以 |
timeStamp | long |
创建日志的时间戳。 |
marker | Marker |
与日志请求相关联的Marker对象,注意“Marker”有可能为null,所以你要确保它不能是null。 |
mdc | Map |
包含创建日志期间的MDC所有值得map。访问方法是:mdc.get("myKey")
|
throwable | java.lang.Throwable | 如果没有异常与日志关联"throwable" 变量为 null. 不幸的是, "throwable"
不能被序列化。在远程系统上永远为null,对于与位置无关的表达式请使用下面的变量throwableProxy |
throwableProxy |
IThrowableProxy |
与日志事件关联的异常代理。如果没有异常与日志事件关联,则变量"throwableProxy" 为 null. 当异常被关联到日志事件时,"throwableProxy" 在远程系统上不会为null |
:用于配置符合过滤条件的操作
:用于配置不符合过滤条件的操作
例如:过滤掉所有日志消息中不包含“billing”字符串的日志。
-
<</span>configuration>
-
-
<</span>appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> -
<</span>filter class="ch.qos.logback.core.filter.EvaluatorFilter"> -
<</span>evaluator> -
<</span>ex pre ssion>return message.contains("billing"); </</span>ex pre ssion> -
</</span>evaluator> -
<</span>OnMatch>ACCEPT </</span>OnMatch> -
<</span>OnMismatch>DENY</</span>OnMismatch> -
</</span>filter> -
<</span>encoder> -
<</span>pattern> -
%-4relative [%thread] %-5level %logger - %msg%n -
</</span>pattern> -
</</span>encoder> -
</</span>appender> -
-
<</span>root level="INFO"> -
<</span>appender-ref ref="STDOUT" /> -
</</span>root> -
</</span>configuration>
匹配器,尽管可以使用String类的matches()方法进行模式匹配,但会导致每次调用过滤器时都会创建一个新的Pattern对象,为了消除这种开销,可以预定义一个或多个matcher对象,定以后就可以在求值表达式中重复引用。是的子标签。
中包含两个子标签,一个是,用于定义matcher的名字,求值表达式中使用这个名字来引用matcher;另一个是,用于配置匹配条件。
例如:
-
<</span>configuration
debug="true"> -
-
<</span>appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> -
<</span>filter class="ch.qos.logback.core.filter.EvaluatorFilter"> -
<</span>evaluator> -
<</span>matcher> -
<</span>Name>odd</</span>Name> -
-
<</span>regex>statement [13579] </</span>regex> -
</</span>matcher> -
-
<</span>exp res sion>odd.matches(formattedMessage)</</span>e pre s sion> -
</</span>evaluator> -
<</span>OnMismatch>NEUTRAL</</span>OnMismatch> -
<</span>OnMatch>DENY</</span>OnMatch> -
</</span>filter> -
<</span>encoder> -
<</span>pattern>%-4relative [%thread] </</span>pattern>%-5level %logger - %msg%n -
</</span>encoder> -
</</span>appender> -
-
<</span>root level="DEBUG"> -
<</span>appender-ref ref="STDOUT" /> -
</</span>root> -
</</span>configuration>
其他Filter不太常用我这里就不讲了,大家可以参见官网。