java日志组件学习4:logback配置使用

1、快速使用

maven配置:

		<dependency>
			<groupId>ch.qos.logback</groupId>
			<artifactId>logback-classic</artifactId>
			<version>1.2.3</version>
			<scope>test</scope>
		</dependency>

新建文件logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="1 seconds" debug="false">
	<property name="LOG_FILE" value="/log/tomcat/myJOb/myJOb.error.log" />
	<property name="appName" value="myJOb"/>
    <contextName>${appName}</contextName>
	<timestamp key="byDate" datePattern="yyyyMMdd" />
	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>%d{HH:mm:ss.SSS} %-5level %logger{50} - %msg%n</pattern>
		</encoder>
    </appender>
	<appender name="FILE" class="ch.qos.logback.core.FileAppender">
	    <file>${LOG_FILE}</file>
	    <append>true</append>
	    <immediateFlush>true</immediateFlush>
	    <encoder>
	      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
	    </encoder>
  	</appender>
    <appender name="fileRolling" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_FILE}</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_FILE}-%d{yyyy-MM-dd}.%i.zip</fileNamePattern>
            <maxHistory>15</maxHistory>
            <maxFileSize>100MB</maxFileSize>
            <totalSizeCap>1GB</totalSizeCap>
            <cleanHistoryOnStart></cleanHistoryOnStart>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>	
	<logger name="org.springframework" level="INFO" additivity="true"></logger>
	<root level="WARN">
		<appender-ref ref="STDOUT" />
		<appender-ref ref="fileRolling" />
	</root>
</configuration>

注:

1.logback首先会试着查找logback.groovy文件;

2.当没有找到时,继续试着查找logback-test.xml文件;

3.当没有找到时,继续试着查找logback.xml文件;

4.如果仍然没有找到,则使用默认配置(打印到控制台)。

1、configuration包含的属性

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

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

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

2、contextName

每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。可以通过%contextName来打印日志上下文名称,一般来说我们不用这个属性,可有可

3、property

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

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

4、timestamp

key:标识此timestamp的名字;

datePattern:设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循java.txt.SimpleDateFormat的格式。

5、appender

负责写日志的组件。

name:指定appender名称

class:指定appender的全限定名。

  • ConsoleAppenderch.qos.logback.core.ConsoleAppender
  • FileAppenderch.qos.logback.core.FileAppender
  • RollingFileAppenderch.qos.logback.core.rolling.RollingFileAppender
6、encoder

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

目前PatternLayoutEncoder 是唯一有用的且默认的encoder

7、pattern

用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“%”进行转义。

pattern里面的转换符说明:

c {length } lo {length } logger {length }输出日志的logger名,可有一个整形参数,功能是缩短logger名,设置为0表示只输入logger最右边点符号之后的字符串。 Conversion specifier Logger name Result %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 }输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用,除非执行速度不造成任何问题。
contextName cn输出上下文名称。
d {pattern } date {pattern }输出日志的打印日志,模式语法与java.text.SimpleDateFormat 兼容。 Conversion Pattern Result %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 - 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{3} 输出为: 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* ){r, t}p 为日志内容,r 是正则表达式,将p 中符合r 的内容替换为t 。 例如, “%replace(%msg){’\s’, ‘’}”
8、ConsoleAppender

把日志添加到控制台

encoder节点:对日志进行格式化。

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

9、FileAppender:

把日志添加到文件

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

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

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

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

immediteFlush节点:配置使用缓存(缓存8k)

10、RollingFileAppender:

滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。

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

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

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

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

triggeringPolicy节点: 告知 RollingFileAppender 什么时候激活滚动。

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

11、rollingPolicy(日志文件滚动策略)
  • TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。ch.qos.logback.core.rolling.TimeBasedRollingPolicy

    fileNamePattern节点:活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次。log/check.%d{yyyy-MM-dd}.log

    maxHistory节点: 日志文件保留天数 。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。

    totalSizeCap : 日志文件总体的最大值,达到之后就不再产生日志。

    cleanHistoryOnStart:开始的时候清楚文件

  • FixedWindowRollingPolicy: 根据固定窗口算法重命名文件的滚动策略。ch.qos.logback.core.rolling.FixedWindowRollingPolicy

    minIndex节点:窗口索引最小值

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

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

  • SizeAndTimeBasedRollingPolicy:当在时间周期内日志文件超过指定大小,则创建新的日志文件,否则每一个时间周期生成一个日志。ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy

    fileNamePattern:活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次。

    maxHistory: 日志文件保留天数 。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。

    totalSizeCap:日志文件总体的最大值,达到之后就不再产生日志。

    cleanHistoryOnStart:开始的时候清楚文件

    maxFileSize:单个日志文件最大值,达到之后就进行切割。

12、triggeringPolicy(日志文件滚动的触发策略)

classch.qos.logback.core.rolling.SizeBasedTriggeringPolicy

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

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

13、loger

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定appender。

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

level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。

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

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

14、root

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

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

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

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

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

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

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

16、filter:

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

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

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

17、LevelFilter

级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。ch.qos.logback.classic.filter.LevelFilter

level节点:设置过滤级别

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

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

18、ThresholdFilter

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

19、EvaluatorFilter

求值过滤器,评估、鉴别日志是否符合指定条件。需要额外的两个JAR包,commons-compiler.jar和janino.jar。

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

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

Name Type Description

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

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

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

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

20、matcher

name节点:用于定义matcher的名字,求值表达式中使用这个名字来引用matcher。

regex节点:用于配置匹配条件。

2、读取配置文件
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Logger logger = LoggerFactory.getLogger(App.class);
public static void load (String externalConfigFileLocation) throws IOException,JoranException{  
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();    
File externalConfigFile = new File(externalConfigFileLocation);  
    if(!externalConfigFile.exists()){  
        throw new IOException("Logback External Config File Parameter does not reference a file that exists");  
    }else{  
        if(!externalConfigFile.isFile()){  
            throw new IOException("Logback External Config File Parameter exists, but does not reference a file");  
        }else{  
            if(!externalConfigFile.canRead()){  
                throw new IOException("Logback External Config File exists and is a file, but cannot be read.");  
            }else{  
                JoranConfigurator configurator = new JoranConfigurator();  
                configurator.setContext(lc);  
                lc.reset();  
                configurator.doConfigure(externalConfigFileLocation);  
                //打印logback 的内部状态
                StatusPrinter.printInCaseOfErrorsOrWarnings(lc);  
            }  
        }     
    }  
}  
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值