springboot 日志文件引用
1、日志框架
市面上日志框架:
日志门面 | 日志实现 |
---|---|
JCL/SLF4J/jboss-logging | Log4j JUL Log4j2 Logback |
springboot:底层是spring框架,spring框架默认的日志是用JCL,缺陷较多,基本不用
2.springboot日志选择
springboot的启动文件下,有start-logging依赖,默认就是slf4j和logback日志框架
父依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter</artifactId>
</dependency>
父下面实际的日志子依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐logging</artifactId>
</dependency>
- [springboot: 建议选用ALF4J作为日志框架]
2.1使用slf4j步骤:
- 将系统中默认的日志框架先排除出去
- 用中间包替换原有的日志框架
- 导入slf4j的其它实现
配置样例:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<!--例如移除spring‐boot‐starter‐logging,使用log4j日志框架-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
除了pom文件配置需要修改,还要再配置文件目录下添加命名格式为log4j2-spring.xml的日志配置文件
3.springboot日志配置文件
3.1 日志配置规定
日志输出格式规定:
%d表示日期时间,
%thread表示线程名,
%‐5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符,否则按照句点分割。
%msg:日志消息,
%n是换行符
‐‐>
%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n
需要springboot的高级功能,日志文件名称就要写成logback-spring-dev.xml形式,再在application.yml文件中通过logging.config=logback-spring-dev.xml来指定执行的日志配置文件
3.2 实战样例
1.application.yml文件配置形式
logging:
config: classpath:logback-spring-dev.xml
2.pom文件添加依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>>
</dependency>
3.开发、测试、生成环境配置形式
3.1 开发环境logback-spring-dev.xml的配置形式
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<jmxConfigurator/>
<!-- 彩色日志 -->
<!-- 彩色日志依赖的渲染类 -->
<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(-){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(%6L){magenta} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!-- 控制台输出, 生产环境去除 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
</encoder>
</appender>
<logger name="com.multithread" level="debug" additivity="false">
<appender-ref ref="CONSOLE"/>
</logger>
<root level="info">
<appender-ref ref="CONSOLE"/>
</root>
</configuration>
3.2 测试环境logback-spring-test.xml的配置形式
<?xml version="1.0" encoding="UTF-8"?>
<!-- Logback configuration. See http://logback.qos.ch/manual/index.html -->
<configuration scan="true" scanPeriod="10 seconds">
<jmxConfigurator/>
<!--<include resource="org/springframework/boot/logging/logback/base.xml"/>-->
<!-- 日志目录 -->
<property name="LOG_HOME" value="/apps/testapp/logs/ib-web"/>
<!-- 彩色日志 -->
<!-- 彩色日志依赖的渲染类 -->
<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(-){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(%6L){magenta} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<property name="File_LOG_PATTERN"
value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p - [%15.15t] %-40.40logger{39} %6L : %m%n"/>
<!-- 日志文件最大的大小 -->
<property name="File_LOG_MAX_SIZE" value="1GB"/>
<!-- 日志最大保存天数 -->
<property name="File_LOG_MAX_HISTORY" value="30"/>
<!-- 日志文件名称 -->
<property name="ALL_File_NAME" value="%d{yyyy-MM-dd}/all-%d{HH}.log"/>
<property name="ERR_File_NAME" value="%d{yyyy-MM-dd}/error.log"/>
<!-- 控制台输出, 生产环境去除 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
</encoder>
</appender>
<!-- 按照每小时生成日志文件,打印全部日志 -->
<appender name="ALL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_HOME}/${ALL_File_NAME}</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>${File_LOG_MAX_HISTORY}</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${File_LOG_PATTERN}</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>${File_LOG_MAX_SIZE}</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 按照每小时生成日志文件,只打印error日志 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_HOME}/${ERR_File_NAME}</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>${File_LOG_MAX_HISTORY}</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${File_LOG_PATTERN}</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>${File_LOG_MAX_SIZE}</MaxFileSize>
</triggeringPolicy>
</appender>
<logger name="com.ideal" level="debug" additivity="false">
<appender-ref ref="CONSOLE"/>
<!--<appender-ref ref="ALL_FILE"/>-->
<!--<appender-ref ref="ERROR_FILE"/>-->
</logger>
<root level="info">
<!-- 控制台打印info及以上级别系统日志 -->
<appender-ref ref="CONSOLE"/>
<!-- 文件记录error级别系统日志 -->
<!--<appender-ref ref="ERROR_FILE"/>-->
</root>
</configuration>
3.3 生产环境logback-spring-prd.xml的配置形式
<?xml version="1.0" encoding="UTF-8"?>
<!-- Logback configuration. See http://logback.qos.ch/manual/index.html -->
<configuration scan="true" scanPeriod="10 seconds">
<jmxConfigurator/>
<!--<include resource="org/springframework/boot/logging/logback/base.xml"/>-->
<!-- 日志目录 -->
<property name="LOG_HOME" value="/home/webapp/logs/ib-web"/>
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<property name="File_LOG_PATTERN"
value="%d{yyyy-MM-dd HH:mm:ss.SSS} %5p - [%15.15t] %-40.40logger{39} %6L : %m%n"/>
<!-- 日志文件最大的大小 -->
<property name="File_LOG_MAX_SIZE" value="1GB"/>
<!-- 日志最大保存天数 -->
<property name="File_LOG_MAX_HISTORY" value="30"/>
<!-- 日志文件名称 -->
<property name="ALL_File_NAME" value="%d{yyyy-MM-dd}/all-%d{HH}.log"/>
<property name="ERR_File_NAME" value="%d{yyyy-MM-dd}/error.log"/>
<!-- 按照每小时生成日志文件,打印全部日志 -->
<appender name="ALL_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_HOME}/${ALL_File_NAME}</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>${File_LOG_MAX_HISTORY}</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${File_LOG_PATTERN}</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>${File_LOG_MAX_SIZE}</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 按照每天生成日志文件,只打印error日志 -->
<appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_HOME}/${ERR_File_NAME}</FileNamePattern>
<!--日志文件保留天数-->
<MaxHistory>${File_LOG_MAX_HISTORY}</MaxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${File_LOG_PATTERN}</pattern>
</encoder>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>${File_LOG_MAX_SIZE}</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- 彩色日志 -->
<!-- 彩色日志依赖的渲染类 -->
<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(-){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(%6L){magenta} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!-- 控制台输出, 生产环境去除 -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
</encoder>
</appender>
<!--<logger name="com.ideal" level="debug" additivity="false">-->
<!--<appender-ref ref="CONSOLE"/>-->
<!--</logger>-->
<logger name="com.ideal" level="info" additivity="false">
<appender-ref ref="ALL_FILE"/>
<appender-ref ref="ERROR_FILE"/>
</logger>
<root level="error">
<!-- 文件记录error级别系统日志 -->
<appender-ref ref="ERROR_FILE"/>
</root>
</configuration>