欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

SpringBoot日志文件配置

程序员文章站 2022-03-05 08:09:59
...

SpringBoot默认使用LogBack日志配置文件,并用INFO级别输出到控制台。在运行应用程序和其他例子时,你应该已经看到很多INFO级别的日志了。
LOGBack日志配置的详细内容请看官网(https://logback.qos.ch/manual/appenders.html#rfaTriggeringPolicy)

一、LogBack日志文件的简单介绍
1、根节点:configuration
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
根节点有5个子节点,下面一一会详细介绍

<configuration scan="true" scanPeriod="60s" debug="false">
</configuration>

2、子节点一 :root
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL,默认是DEBUG,可以包含零个或多个元素,标识这个appender将会添加到这个logger。
日志控制级别:TRACE < DEBUG < INFO < WARN < ERROR < FATAL

<!--指定最基础的日志输出级别 -->
<root level="INFO">
<appender-ref ref="CONSOLE" />
</root>

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

<contextName>logback</contextName>

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

<!-- 配置程序日志文件名称,可以在application.yml文件中传递进来 -->
<property name="appname" value="web" />
<!-- 存放日志文件的路径的根目录 -->
<property name="logdir" value="F:/logs/${appname}" />

5、子节点四:appender输出日志文件节点
appender用来格式化日志输出节点,有两个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
1、按照时间对日志文件进行回滚(TimeBasedRollingPolicy)

<appender name="DETAIL"
		class="ch.qos.logback.core.rolling.RollingFileAppender" additivity="false">
		<File>${LOG_HOME}/${APP}_detail.log</File>
		<encoder>
			<pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0} %X{ServiceId} - %m%n</pattern>
		</encoder>
           <!—按天去回滚 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<fileNamePattern>${LOG_HOME}/${APP}_detail.log.%d{yyyy-MM-dd}</fileNamePattern>
		<!--只保留最近7天的日志-->
        	<maxHistory>7</maxHistory>
           <!--设置文件总大小-->
           <totalSizeCap>1GB</totalSizeCap>
		</rollingPolicy>
</appender>

2、按照文件大小回滚日志文件(FixedWindowRollingPolicy)

<!-- 按照文件大小回滚日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>${logdir}/${appname}_detail.log</file>
		<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
			<fileNamePattern>${logdir}/${appname}_detail.%i.log.%d{yyyy-MM-dd}</fileNamePattern>
			<minIndex>1</minIndex>
			<maxIndex>3</maxIndex>
		</rollingPolicy>

		<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
			<maxFileSize>5MB</maxFileSize>
		</triggeringPolicy>
		<encoder>
			<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
		</encoder>
</appender>

3、按时间和文件大小回滚日志文件(SizeAndTimeBasedRollingPolicy)

<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<File>${logdir}/${appname}_error.log</File>
		<!--如果只是想要 Error 级别的日志,那么需要过滤一下,默认是 info 级别的,ThresholdFilter-->
    	<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        	<level>Error</level>
   	 	</filter>
		<!-- 日志编码编码格式 -->
		<encoder>
			<pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} - %m%n</pattern>
		</encoder>
		<!--滚动策略,按照时间和文件大小滚动SizeAndTimeBasedRollingPolicy -->
		<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
			<!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间 -->
			<fileNamePattern>${logdir}/${appname}_error.%i.log.%d{yyyy-MM-dd}
			</fileNamePattern>
			<!--只保留最近15天的日志 -->
			<maxHistory>15</maxHistory>
			<!-- 每个文件的最大容量 -->
			<maxFileSize>100MB</maxFileSize>
			<!-- 日志文件总的容量 -->
			<totalSizeCap>1GB</totalSizeCap>
		</rollingPolicy>
</appender>

6、子节点五:loger
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。仅有一个name属性,一个可选的level和一个可选的addtivity属性
name:用来指定受此loger约束的某一个包或者具体的某一个类。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。如果未设置此属性,那么当前loger将会继承上级的级别。
addtivity:是否向上级loger传递打印信息。默认是true
第一种:带有loger的配置,不指定级别,不指定appender

<logger name="druid.sql.Statement" level="DEBUG" />
<logger name="cn.com.odin.item.dao" level="TRACE"/>

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

<!-- 控制com.sun.action类的日志打印,打印级别为“WARN”; additivity属性为false,表示此loger的打印信息不再向上级传递; --> 
<logger name="com.sun.action" level="ERROR" additivity="false">
        <appender-ref ref="ERROR"/>
</logger>

控制com.sun.action类的日志打印,打印级别为“ERROR”,additivity属性为false,表示此loger的打印信息不再向上级传递; 指定了名字为“ERROR”的appender;这时候执行com.sun.action.loginAction类的login方法时,先执行,将级别为“ERROR”及大于“ERROR”的日志信息交给此loger指定的名为“ERROR”的appender处理,在控制台中打出日志,不再向上级root传递打印信息。
二、多环境日志文件配置
1、logback-spring.xml配置文件

<springProfile name="test,dev">
    <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
        <appender-ref ref="consoleLog"/>
    </logger>
</springProfile>
<!-- 生产环境. -->
<springProfile name="prod">
    <logger name="com.example.demo.controller" level="INFO" additivity="false">
        <appender-ref ref="consoleLog"/>
    </logger>
</springProfile>

2、application.yml配置文件

spring:
  profiles:
    active:
      - dev

三、自定义配置文件路径
1、application.yml配置文件

logback:
  logdir: /Users/dev/log/demo
  appname: demo

2、logback-spring.xml日志配置文件

<!--application.yml 传递参数,不能使用logback 自带的<property>标签 -->
<springProperty scope="context" name="appname" source="logback.appname"/>
<springProperty scope="context" name="logdir" source="logback.logdir"/>

四、日志配置文件的简单案例

1、创建logback-spring.xml日志配置文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
	<!-- 配置程序日志文件名称,可以在application.yml文件中传递进来 -->
	<property name="appname" value="web" />
	<!-- 存放日志文件的路径的根目录 -->
	<property name="logdir" value="F:/logs/${appname}" />
	<!--输出到控制台 ConsoleAppender -->
	<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
		<!-- 日志编码编码格式 -->
		<encoder>
			<pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p%-22c{0}%X{ServiceId}- %m%n</pattern>
		</encoder>
	</appender>
	<!-- 设置错误日志文件的回滚方式 -->
	<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<File>${logdir}/${appname}_error.log</File>
		<!--如果只是想要 Error 级别的日志,那么需要过滤一下,默认是 info 级别的,ThresholdFilter-->
    	<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        	<level>Error</level>
   	 </filter>
		<!-- 日志编码编码格式 -->
		<encoder>
			<pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} - %m%n</pattern>
		</encoder>
		<!--滚动策略,按照时间滚动SizeAndTimeBasedRollingPolicy -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间 -->
			<fileNamePattern>${logdir}/${appname}_error.log.%d{yyyy-MM-dd}
			</fileNamePattern>
			<!--只保留最近15天的日志 -->
			<maxHistory>15</maxHistory>
			<!-- 日志文件总的容量 -->
			<totalSizeCap>1GB</totalSizeCap>
		</rollingPolicy>
	</appender>
    <!-- 按照文件大小回滚日志文件 -->
	<appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>${logdir}/${appname}_debug.log</file>
		<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
			<fileNamePattern>${logdir}/${appname}_debug.%i.log.%d{yyyy-MM-dd}</fileNamePattern>
			<minIndex>1</minIndex>
			<maxIndex>3</maxIndex>
		</rollingPolicy>
		<!-- 按照文件的大小回滚日志文件 -->
		<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
			<maxFileSize>50MB</maxFileSize>
		</triggeringPolicy>
		<encoder>
			<pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
		</encoder>
	</appender>
	<!-- 设置细节日志文件的回滚方式 -->
	<appender name="DETAIL" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<File>${logdir}/${appname}_detail.log</File>
		<!--如果只是想要 Info 级别的日志,只是过滤 info 还是会输出 Error 日志,因为 Error 的级别高,
   			 所以我们使用下面的策略,可以避免输出 Error 的日志-->
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
			<!--过滤 Error -->
			<level>ERROR</level>
			<!--匹配到就禁止 -->
			<onMatch>DENY</onMatch>
			<!--没有匹配到就允许 -->
			<onMismatch>ACCEPT</onMismatch>
		</filter>
		<!-- 日志编码编码格式 -->
		<encoder>
			<pattern>%d{yy-MM-dd.HH:mm:ss.SSS} [%-16t] %-5p %-22c{0}%X{ServiceId} - %m%n</pattern>
		</encoder>
		<!--滚动策略,按照时间滚动SizeAndTimeBasedRollingPolicy -->
		<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
			<!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间 -->
			<fileNamePattern>${logdir}/${appname}_detail.%i.log.%d{yyyy-MM-dd}</fileNamePattern>
			<!--只保留最近15天的日志 -->
			<maxHistory>15</maxHistory>
			<!-- 每个文件的最大容量 -->
			<maxFileSize>100MB</maxFileSize>
			<!-- 日志文件总的容量 -->
			<totalSizeCap>1GB</totalSizeCap>
		</rollingPolicy>
	</appender>
	<!-- 控制com.sun.action类的日志打印,打印级别为“WARN”; 
		 additivity属性为false,表示此loger的打印信息不再向上级传递; --> 
	<logger name="com.sun.action" level="ERROR" additivity="false">
        <appender-ref ref="ERROR"/>
    </logger>
	<!--指定最基础的日志输出级别 -->
	<root level="INFO">
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="ERROR"/>
		<appender-ref ref="DETAIL" />
		<appender-ref ref="DEBUG"/>
	</root>	 
</configuration>
相关标签: logback

上一篇: Swap Nodes in Pairs

下一篇: Slf4j LogBack