logback日志使用说明
0 logback介绍
- 日志是项目运行的基本功能，通过指定格式的日志，可以帮助程序员观察项目运行的情况，以及排查问题。
Slf4j是一个针对各种java日志框架的统一抽象- 常用的日志框架：
java.util.logging,log4j,logback，commons-logging- 本文主要介绍
logback日志框架，logback是log4j的作者开发的新一代日志框架，目前应用最广泛。Springboot默认使用的也是logback，且默认级别为info。- 日志加载顺序：
logback.xml->application.yml->logback-spring.xml- 官方推荐使用
logback-spring.xml，因为带spring后缀的可以使用springprofile标签
1 springboot引入logback
引入logback可以直接引入下列maven依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
<version>2.1.11.RELEASE</version>
<scope>compile</scope>
</dependency>
如果maven中使用到了springboot-boot-starter或springboot-boot-starter-web也会间接引入logback
2 日志格式
2.1 pattern：输出格式
<pattern>%d %-5level [%thread][%X{clientIp}][%X{userId}][%X{sessionId}] %logger{68} %line - %msg%n</pattern>
格式说明：
--时间 日志级别 [线程号][客户端IP][客户编号][sessionId] 日志发生类 行号 - 日志详细信息
--%d：时间
--%-5level：日志级别
--%thread：线程号
--%X{clientIp}：客户端IP
--%X{userId}：客户编号
--%X{sessionId}：sessionId
--%logger{68}：日志发生类
--%line：行号
--%msg：日志详情，即log.info中的内容
--%n：换行
2.2 appender：日志渲染器
文件输出的主要配置，以指定格式将日志输出到指定文件中，可以配置文件名称，大小，保存时间等
file: 生成的日志文件名称rollingPolicy: 滚动策略fileNamePattern: 定义归档日志文件的名称maxFileSize: 单个日志文件的最大容量, 达到最大容量后会触发日志滚动操作, 生成新的日志文件timeBasedFileNamingAndTriggeringPolicy: 按时间回滚的同时, 按照文件大小来回滚maxHistory: 归档日志的最大数量, 以异步方式删除旧文件, 如果通过fileNamePattern中的%d{yyyy-MM}指定滚动周期为月度滚动，并将maxHistory设置为6，那么存档文件中超过6个月的文件将被删除cleanhistoryonstart: 应用启动时, 归档文件将会被删除, 默认的值为 false, 解决如果应用执行比较短，可能不会触发删除归档日志操作的问题encoder: 控制日志输出的格式和编码
<!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
<property name="log.path" value="d:/logs/projectName/" />
<!--输出到文件 -->
<appender name="ALL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<file>${log.path}/log_all.log</file>
<!--日志文件输出格式 -->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略，按日期，按大小记录 -->
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 每天日志归档路径以及格式 -->
<fileNamePattern>${log.path}/logs/log-all-%d{yyyy-MM-dd}.%i.log
</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数 -->
<maxHistory>15</maxHistory>
<!-- 应用启动时, 归档文件将会被删除, 默认的值为 false -->
<cleanhistoryonstart>true</cleanhistoryonstart>
</rollingPolicy>
</appender>
2.3 root：启动配置
root实际是配置启动哪个appender
<root level="info">
<appender-ref ref="ALL_FILE"/>
<appender-ref ref="CONSOLE" />
<!--
<appender-ref ref="DEBUG_FILE" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="ERROR_FILE" />-->
</root>
3 日志环境配置
-
- 指定springboot使用的日志配置
- 我们可以在springboot的配置文件中指明使用哪个xml作为log的配置，比如：
logging.config=classpath:logback-spring-sit.xml - 如果不指定，则会按照
logback.xml->application.yml->logback-spring.xml的顺序去查找是否存在默认的配置。
-
- xml中使用springProfile标签指定哪些环境下应该使用哪些配置
- 我们也可以在具体的日志配置xml文件中指定在哪些环境下使用哪些配置，比如：
<springProfile name="dev,sit">
<root level="INFO">
<appender-ref ref="CONSOLE-WITH-COLOR"/>
<appender-ref ref="FILE"/>
</root>
</springProfile>
<springProfile name="prod">
<root level="INFO">
<appender-ref ref="CONSOLE-WITH-COLOR"/>
<appender-ref ref="FILE"/>
</root>
</springProfile>
这样的话，就不需要建议多个xml文件了，使用一个默认的logback-spring.xml即可。
4 完整logback-spring.xml文件
设置了不同标签及注释，可以按需使用
彩色日志需引入springboot依赖
<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true -->
<!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="10 seconds">
<!--<include resource="org/springframework/boot/logging/logback/base.xml"
/> -->
<contextName>logback</contextName>
<!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
<property name="log.path" value="d:/logs/admin/" />
<!-- 彩色日志 -->
<!-- 彩色日志依赖的渲染类 -->
<conversionRule conversionWord="clr"
converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex"
converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx"
converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<!-- 彩色日志格式 -->
<property name="CONSOLE_LOG_PATTERN"
value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />
<!--输出到控制台 -->
<appender name="CONSOLE"
class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<encoder>
<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
<!-- 设置字符集 -->
<charset>UTF-8</charset>
</encoder>
</appender>
<!--输出到文件 -->
<!-- 时间滚动输出 level为 INFO 日志 -->
<appender name="ALL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文件的路径及文件名 -->
<file>${log.path}/log_all.log</file>
<!--日志文件输出格式 -->
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略，按日期，按大小记录 -->
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 每天日志归档路径以及格式 -->
<fileNamePattern>${log.path}/logs/log-all-%d{yyyy-MM-dd}.%i.log
</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文件保留天数 -->
<maxHistory>15</maxHistory>
<!-- 归档文件将会被删除, 默认的值为 false -->
<cleanhistoryonstart>true</cleanhistoryonstart>
</rollingPolicy>
</appender>
<!-- 将不同级别日志打印至指定文件-->
<!--
<!– 时间滚动输出 level为 DEBUG 日志 –>
<appender name="DEBUG_FILE"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<!– 正在记录的日志文件的路径及文件名 –>
<file>${log.path}/log_debug.log</file>
<!–日志文件输出格式 –>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
<!– 设置字符集 –>
</encoder>
<!– 日志记录器的滚动策略，按日期，按大小记录 –>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!– 日志归档 –>
<fileNamePattern>${log.path}/log-debug-%d{yyyy-MM-dd}.%i.log
</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!–日志文件保留天数 –>
<maxHistory>15</maxHistory>
</rollingPolicy>
<!– 此日志文件只记录debug级别的 –>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>debug</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!– 时间滚动输出 level为 INFO 日志 –>
<appender name="INFO_FILE"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<!– 正在记录的日志文件的路径及文件名 –>
<file>${log.path}/log_info.log</file>
<!–日志文件输出格式 –>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
<!– 日志记录器的滚动策略，按日期，按大小记录 –>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!– 每天日志归档路径以及格式 –>
<fileNamePattern>${log.path}/log-info-%d{yyyy-MM-dd}.%i.log
</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!–日志文件保留天数 –>
<maxHistory>15</maxHistory>
</rollingPolicy>
<!– 此日志文件只记录info级别的 –>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>info</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!– 时间滚动输出 level为 WARN 日志 –>
<appender name="WARN_FILE"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<!– 正在记录的日志文件的路径及文件名 –>
<file>${log.path}/log_warn.log</file>
<!–日志文件输出格式 –>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
<!– 此处设置字符集 –>
</encoder>
<!– 日志记录器的滚动策略，按日期，按大小记录 –>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/log-warn-%d{yyyy-MM-dd}.%i.log
</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!–日志文件保留天数 –>
<maxHistory>15</maxHistory>
</rollingPolicy>
<!– 此日志文件只记录warn级别的 –>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>warn</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
<!– 时间滚动输出 level为 ERROR 日志 –>
<appender name="ERROR_FILE"
class="ch.qos.logback.core.rolling.RollingFileAppender">
<!– 正在记录的日志文件的路径及文件名 –>
<file>${log.path}/log_error.log</file>
<!–日志文件输出格式 –>
<encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
<charset>UTF-8</charset>
<!– 此处设置字符集 –>
</encoder>
<!– 日志记录器的滚动策略，按日期，按大小记录 –>
<rollingPolicy
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${log.path}/log-error-%d{yyyy-MM-dd}.%i.log
</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>10MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!–日志文件保留天数 –>
<maxHistory>15</maxHistory>
</rollingPolicy>
<!– 此日志文件只记录ERROR级别的 –>
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
</appender>
-->
<!-- <logger>用来设置某一个包或者具体的某一个类的日志打印级别、 以及指定<appender>。<logger>仅有一个name属性，
一个可选的level和一个可选的addtivity属性。 name:用来指定受此logger约束的某一个包或者具体的某一个类。 level:用来设置打印级别，大小写无关：TRACE,
DEBUG, INFO, WARN, ERROR, ALL 和 OFF， 还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
如果未设置此属性，那么当前logger将会继承上级的级别。 addtivity:是否向上级logger传递打印信息。默认是true。 -->
<!--<logger name="org.springframework.web" level="info"/> -->
<!--<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor"
level="INFO"/> -->
<!-- 使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别： -->
<!-- root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性 level:用来设置打印级别，大小写无关：TRACE,
DEBUG, INFO, WARN, ERROR, ALL 和 OFF， 不能设置为INHERITED或者同义词NULL。默认是DEBUG 可以包含零个或多个元素，标识这个appender将会添加到这个logger。 -->
<!--开发环境:打印控制台 -->
<!--
<springProfile name="dev">
<logger name="com.nmys.view" level="debug" />
</springProfile>
-->
<root level="info">
<appender-ref ref="ALL_FILE"/>
<appender-ref ref="CONSOLE" />
<!-- <appender-ref ref="DEBUG_FILE" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="WARN_FILE" />
<appender-ref ref="ERROR_FILE" />-->
</root>
<!--生产环境:输出到文件 -->
<!--<springProfile name="pro"> -->
<!--<root level="info"> -->
<!--<appender-ref ref="CONSOLE" /> -->
<!--<appender-ref ref="DEBUG_FILE" /> -->
<!--<appender-ref ref="INFO_FILE" /> -->
<!--<appender-ref ref="ERROR_FILE" /> -->
<!--<appender-ref ref="WARN_FILE" /> -->
<!--</root> -->
<!--</springProfile> -->
</configuration>
805
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
