Logback配置介绍与实例

最新推荐文章于 2022-08-24 18:43:19 发布

SugarEntiItsME

最新推荐文章于 2022-08-24 18:43:19 发布

阅读量295

点赞数 1

分类专栏： spring

原文链接：https://www.cnblogs.com/ryelqy/p/10314147.html

版权

spring 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

一、Logback默认配置的步骤

在 classpath下查找文件logback-test.xml；
如果文件不存在，则查找文件logback.xml；
如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，日志将输出到控制台（root logger默认级别是 DEBUG）。

二、logback.xml的结构

在这里插入图片描述

1. <configuration>
1）作用：

scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod: 监测配置文件是否有修改的时间间隔。当scan为true时，此属性生效。默认的时间间隔为1分钟。默认时间单位时的单位是毫秒。
debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

2）示例：

<configuration debug="false" scan="true" scanPeriod="60 seconds">
    <!-- 假装这儿有一堆配置 -->
</configuration>

2. <contextName>
1）作用:每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。
2）示例：

<contextName>sugar\</contextName>

3. <property>
1）作用:用来定义变量值的标签，有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以通过"${}"来使用变量。
例如使用定义上下文名称，然后在设置logger上下文时使用。
2）示例：

<property name="APP_Name" value="sugar" />   
<contextName>${APP_Name}</contextName>

4. <timestamp>
1）作用:两个属性 key:标识此<timestamp> 的名字；datePattern：设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。
2）示例：

<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
<contextName>${bySecond}</contextName>

5. <appender>
1）作用:<appender>是<configuration>的子节点，是负责写日志的组件。
　　<appender>有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。
2）示例：
-----ConsoleAppender：把日志添加到控制台，有以下子节点：
　　<encoder>：对日志进行格式化。（具体参数稍后讲解）
　　<target>：字符串 System.out 或者 System.err ，默认 System.out

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
      <encoder>  
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n\</pattern>  
      </encoder>  
  </appender>

-----FileAppender：把日志添加到文件，有以下子节点：
　　<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
　　<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
　　<encoder>：对记录事件进行格式化。（具体参数稍后讲解）
　　<prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

<appender name="FILE" class="ch.qos.logback.core.FileAppender">  
    <file>testFile.log</file>  
    <append>true</append>  
    <encoder>  
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
    </encoder>  
  </appender>

-----RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：
　　<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
　　<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
　　<encoder>：对记录事件进行格式化。（具体参数稍后讲解）
　　<rollingPolicy>:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。
　　<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
　　<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
–rollingPolicy
TimeBasedRollingPolicy:最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：
<fileNamePattern>:
必要节点，包含文件名及“%d”转换符， “%d”可以包含一个Java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
<maxHistory>:
可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。
FixedWindowRollingPolicy:根据固定窗口算法重命名文件的滚动策略。有以下子节点：
<minIndex>:窗口索引最小值
<maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
<fileNamePattern >:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者没有log%i.log.zip
–triggeringPolicy
SizeBasedTriggeringPolicy:
查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
<maxFileSize>:这是活动文件的大小，默认值是10MB。

6. <logger>
1）作用:用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。
name:用来指定受此loger约束的某一个包或者具体的某一个类。
level:用来设置打印级别（日志级别），大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
addtivity:是否向上级loger传递打印信息。默认是true。
<logger>可以包含零个或多个元素，标识这个appender将会添加到这个logger。
示例：

  <logger name="com.aa.bb" level="ERROR" >
      <appender-ref ref="STDOUT"/>  
  </logger>

7. <root>
1）作用:它也是元素，但是它是根logger,是所有的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。
2）示例：

  <root level="DEBUG">             
      <appender-ref ref="STDOUT" />   
  </root>

8. <shutdownHook>
1）作用:Logback关闭appender
2）官方示例：

<shutdownHook class="ch.qos.logback.core.hook.DelayingShutdownHook"/>

三、完整示例

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="60 seconds">

	<property name="appname" value="sugar" />
	<contextName>${appname}</contextName>
	<!-- 日志文件输出到目录 -->
	<property name="LOG_DIR" value="/export/Logs/${appname}" />

	<!-- 日志文件前缀 -->
	<property name="LOG_PREFIX" value="${appname}" />

	<!-- 默认日志输出格式 -->
	<property name="LOG_MSG" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5p [%c-%L] - %m%n" />


	<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${LOG_MSG}</pattern>
		</encoder>
	</appender>

	<!-- DEBUG日志输出 -->
	<appender name="DEBUG_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>${LOG_DIR}/${LOG_PREFIX}_debug.log</file>
		<!-- 临界值过滤器，过滤掉低于debug的日志 -->
		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
			<level>DEBUG</level>
		</filter>
		<!--
    通过rollingPolicy设置日志滚动的策略，这是使用按照时间滚动
    fileNamePattern属性设置滚动生成文件的格式,这里设置的精确到天，也就是按照天滚动，如果时间设置精确到秒，就按秒来滚动
    maxHistory属性设定最大的文件数，比如按天滚动，这里设置了30天，在第31天日志生成的时候，第一天的日志就会被删掉
    -->
		<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
			<fileNamePattern>${LOG_DIR}/${LOG_PREFIX}_debug.log.%d{yyyy-MM-dd}.%i
			</fileNamePattern>
			<maxFileSize>1GB</maxFileSize>
			<maxHistory>3</maxHistory>
			<totalSizeCap>3GB</totalSizeCap>
		</rollingPolicy>
		<!--encoder和pattern节点组合用于具体输出的日志格式-->
		<encoder>
			<pattern>${LOG_MSG}</pattern>
		</encoder>

	</appender>

	<!-- INFO日志输出 -->
	<appender name="INFO_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>${LOG_DIR}/${LOG_PREFIX}_info.log</file>
		<!-- 使用过滤器，仅仅接收info日志级别的信息到info日志,高于该级别的日志，也不进入 -->
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
			<level>INFO</level>
			<onMatch>ACCEPT</onMatch>
			<onMismatch>DENY</onMismatch>
		</filter>
		<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
			<fileNamePattern>${LOG_DIR}/${LOG_PREFIX}_info.log.%d{yyyy-MM-dd}.%i
			</fileNamePattern>
			<maxFileSize>1GB</maxFileSize>
			<maxHistory>3</maxHistory>
			<totalSizeCap>3GB</totalSizeCap>
		</rollingPolicy>
		<encoder>
			<pattern>${LOG_MSG}</pattern>
		</encoder>
	</appender>


	<!-- ERROR日志输出 -->
	<appender name="ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>${LOG_DIR}/${LOG_PREFIX}_error.log</file>
		<!-- 使用过滤器，仅仅接收error日志级别的信息到error日志 -->
		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
			<level>ERROR</level>
		</filter>
		<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
			<fileNamePattern>${LOG_DIR}/${LOG_PREFIX}_error.log.%d{yyyy-MM-dd}.%i
			</fileNamePattern>
			<maxFileSize>1GB</maxFileSize>
			<maxHistory>7</maxHistory>
			<totalSizeCap>7GB</totalSizeCap>
		</rollingPolicy>
		<encoder>
			<pattern>${LOG_MSG}</pattern>
		</encoder>
	</appender>

	<!-- 异步输出INFO -->
	<appender name="ASYNC_INFO" class="ch.qos.logback.classic.AsyncAppender">
		<queueSize>1024</queueSize>
		<neverBlock>true</neverBlock>
		<appender-ref ref="INFO_LOG" />
	</appender>

	<!-- 异步输出ERROR -->
	<appender name="ASYNC_ERROR" class="ch.qos.logback.classic.AsyncAppender">
		<queueSize>1024</queueSize>
		<neverBlock>true</neverBlock>
		<appender-ref ref="ERROR_LOG" />
	</appender>

	<!-- 关闭org包开头的的debug和info日志，不建议开启该配置，以便观察三方组件 -->
	<logger name="org" level="INFO" />
	<logger name="io.netty" level="ERROR" />
	<logger name="com.test" level="ERROR" />

	<!-- 设置日志级别  将root的打印级别设置为“INFO”，指定了名字为“STDOUT”等appender-->
	<root level="INFO">
		<appender-ref ref="STDOUT" />
		<appender-ref ref="ASYNC_INFO" />
		<appender-ref ref="ASYNC_ERROR" />
	</root>
<!--	Logback关闭appender-->
	<shutdownHook class="ch.qos.logback.core.hook.DelayingShutdownHook" />
</configuration>

参考资料

http://logback.qos.ch/manual/introduction.html
https://www.cnblogs.com/cb0327/p/5759441.html
https://www.cnblogs.com/ryelqy/p/10314147.html
http://www.voidcn.com/article/p-cldyyffs-bvq.html

SugarEntiItsME

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Logback配置介绍与实例

一、Logback默认配置的步骤在 classpath下查找文件logback-test.xml；如果文件不存在，则查找文件logback.xml；如果两个文件都不存在，logback用BasicConfigurator自动对自己进行配置，日志将输出到控制台（root logger默认级别是 DEBUG）。二、logback.xml的结构1. <configuration>1）作用：scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true
复制链接

扫一扫