logback-spring 日志配置以及解决方案

叁歲伎倆 2022-12-08 15:40 206阅读 0赞

背景

springboot编写的项目，部署到Tomcat，需要为服务单独配置日志

工程结构

20200920174010909.png

开始

经过排查，决定使用 logback-spring.xml

首先上文件 内容(参考 三呆子) 他那里是时间滚动，我改成数量滚动

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
  3. <!-- scan:当此属性设置为true时，配置文档如果发生改变，将会被重新加载，默认值为true -->
  4. <!-- scanPeriod:设置监测配置文档是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。
  5.                  当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
  6. <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
  7. <configuration  scan="true" scanPeriod="10 seconds">
  8.     <contextName>logback</contextName>
  10.     <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量。 -->
  11.     <property name="log.path" value="${catalina.base}/logs/" />
  12.     <property name="log.name" value="myweb"/>
  14.     <!--0. 日志格式和颜色渲染 -->
  15.     <!-- 彩色日志依赖的渲染类 -->
  16.     <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
  17.     <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
  18.     <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
  19.     <!-- 彩色日志格式 -->
  20.     <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}}"/>
  22.     <!--1. 输出到控制台-->
  23.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  24.         <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
  25.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  26.             <level>debug</level>
  27.         </filter>
  28.         <encoder>
  29.             <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
  30.             <!-- 设置字符集 -->
  31.             <charset>UTF-8</charset>
  32.         </encoder>
  33.     </appender>
  35.     <!--2. 输出到文档-->
  36.     <!-- 2.1 level为 DEBUG 日志，时间滚动输出  -->
  37.     <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  38.         <!-- 正在记录的日志文档的路径及文档名 -->
  39.         <file>${log.path}/${log.name}-debug.log</file>
  40.         <!--日志文档输出格式-->
  41.         <encoder>
  42.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  43.             <charset>UTF-8</charset> <!-- 设置字符集 -->
  44.         </encoder>
  45.         <!-- 日志记录器的滚动策略，按大小记录 -->
  46.         <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
  47.             <!-- 日志归档 -->
  48.             <fileNamePattern>${log.path}/${log.name}-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  49.             <!--日志文档保留最大个数-->
  50.             <maxIndex>100</maxIndex>
  51.         </rollingPolicy>
  52.         <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
  53.             <!--日志文档大小-->
  54.             <maxFileSize>100MB</maxFileSize>
  55.         </triggeringPolicy>
  58.         <!-- 此日志文档只记录debug级别的 -->
  59.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  60.             <level>debug</level>
  61.             <onMatch>ACCEPT</onMatch>
  62.             <onMismatch>DENY</onMismatch>
  63.         </filter>
  64.     </appender>
  66.     <!-- 2.2 level为 INFO 日志，时间滚动输出  -->
  67.     <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  68.         <!-- 正在记录的日志文档的路径及文档名 -->
  69.         <file>${log.path}/${log.name}-info.log</file>
  70.         <!--日志文档输出格式-->
  71.         <encoder>
  72.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  73.             <charset>UTF-8</charset>
  74.         </encoder>
  75.         <!-- 日志记录器的滚动策略，按大小记录 -->
  76.         <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
  77.             <!-- 每天日志归档路径以及格式 -->
  78.             <fileNamePattern>${log.path}/${log.name}-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  79.             <!--日志文档保留最大个数-->
  80.             <maxIndex>100</maxIndex>
  81.         </rollingPolicy>
  82.         <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
  83.             <!--日志文档大小-->
  84.             <maxFileSize>100MB</maxFileSize>
  85.         </triggeringPolicy>
  86.         <!-- 此日志文档只记录info级别的 -->
  87.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  88.             <level>info</level>
  89.             <onMatch>ACCEPT</onMatch>
  90.             <onMismatch>DENY</onMismatch>
  91.         </filter>
  92.     </appender>
  94.     <!-- 2.3 level为 WARN 日志，时间滚动输出  -->
  95.     <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  96.         <!-- 正在记录的日志文档的路径及文档名 -->
  97.         <file>${log.path}/${log.name}-warn.log</file>
  98.         <!--日志文档输出格式-->
  99.         <encoder>
  100.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  101.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  102.         </encoder>
  103.         <!-- 日志记录器的滚动策略，按大小记录 -->
  104.         <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
  105.             <fileNamePattern>${log.path}/${log.name}-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  106.             <!--日志文档保留最大个数-->
  107.             <maxIndex>100</maxIndex>
  108.         </rollingPolicy>
  109.         <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
  110.             <!--日志文档大小-->
  111.             <maxFileSize>100MB</maxFileSize>
  112.         </triggeringPolicy>
  113.         <!-- 此日志文档只记录warn级别的 -->
  114.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  115.             <level>warn</level>
  116.             <onMatch>ACCEPT</onMatch>
  117.             <onMismatch>DENY</onMismatch>
  118.         </filter>
  119.     </appender>
  121.     <!-- 2.4 level为 ERROR 日志，时间滚动输出  -->
  122.     <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  123.         <!-- 正在记录的日志文档的路径及文档名 -->
  124.         <file>${log.path}/${log.name}-error.log</file>
  125.         <!--日志文档输出格式-->
  126.         <encoder>
  127.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  128.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  129.         </encoder>
  130.         <!-- 日志记录器的滚动策略，按大小记录 -->
  131.         <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
  132.             <fileNamePattern>${log.path}/${log.name}-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  133.             <!--日志文档保留最大个数-->
  134.             <maxIndex>100</maxIndex>
  135.         </rollingPolicy>
  136.         <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
  137.             <!--日志文档大小-->
  138.             <maxFileSize>100MB</maxFileSize>
  139.         </triggeringPolicy>
  141.         <!-- 此日志文档只记录ERROR级别的 -->
  142.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  143.             <level>ERROR</level>
  144.             <onMatch>ACCEPT</onMatch>
  145.             <onMismatch>DENY</onMismatch>
  146.         </filter>
  147.     </appender>
  149.     <!--
  150.         <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
  151.         以及指定<appender>。<logger>仅有一个name属性，
  152.         一个可选的level和一个可选的addtivity属性。
  153.         name:用来指定受此logger约束的某一个包或者具体的某一个类。
  154.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
  155.               还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
  156.               如果未设置此属性，那么当前logger将会继承上级的级别。
  157.         addtivity:是否向上级logger传递打印信息。默认是true。
  158.         <logger name="org.springframework.web" level="info"/>
  159.         <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
  160.     -->
  162.     <!--
  163.         使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
  164.         第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
  165.         第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：
  166.         【logging.level.org.mybatis=debug logging.level.dao=debug】
  167.      -->
  169.     <!--
  170.         root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性
  171.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
  172.         不能设置为INHERITED或者同义词NULL。默认是DEBUG
  173.         可以包含零个或多个元素，标识这个appender将会添加到这个logger。
  174.     -->
  176.     <!-- 4. 最终的策略 -->
  177.     <!-- 4.1 开发环境:打印控制台-->
  178.     <springProfile name="dev">
  179.         <logger name="com.sdcm.pmp" level="debug"/>
  180.     </springProfile>
  182.     <root level="info">
  183.         <appender-ref ref="CONSOLE" />
  184.         <appender-ref ref="DEBUG_FILE" />
  185.         <appender-ref ref="INFO_FILE" />
  186.         <appender-ref ref="WARN_FILE" />
  187.         <appender-ref ref="ERROR_FILE" />
  188.     </root>
  190.      <!--4.2 生产环境:只输出到文档-->
  191. <!-- <springProfile name="pro">
  192.         <root level="info">
  193.             <appender-ref ref="CONSOLE" />
  194.             <appender-ref ref="DEBUG_FILE" />
  195.             <appender-ref ref="INFO_FILE" />
  196.             <appender-ref ref="ERROR_FILE" />
  197.             <appender-ref ref="WARN_FILE" />
  198.         </root>
  199.     </springProfile>-->
  201. </configuration>

application.yml 的配置(控制指定路径的)

  1. # 设置输出日志级别 DEBUG < INFO < WARN < ERROR
  2. logging:
  3.   config: classpath:logback-spring.xml
  4.   level:
  5.     com.package: info

新增日志依赖

  1. <!--使用logback日志-->
  2. <dependency>
  3.     <groupId>ch.qos.logback</groupId>
  4.     <artifactId>logback-classic</artifactId>
  5.     <version>${logback.version}</version>
  6. </dependency>

一般简单的项目到这里基本不会有问题了，但是，真实的远比这里复杂

问题一：

需要日志输出到Tomcat的logs里面

解决

20200920172433270.png

问题二：

日志配置不生效

原因：sprig 优先使用内部的日志配置

分析：1、搜索项目 StaticLoggerBinder 类 (发现有个spring-boot-starter-log4j2多余的)

20200920173628605.png

解决：排除他 （如果还依赖其他工程的话，在那个工程也要加上这个排除）

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter</artifactId>
  4.     <exclusions>
  5.         <exclusion>
  6.             <!--排除-->
  7.             <groupId>org.springframework.boot</groupId>
  8.             <artifactId>spring-boot-starter-log4j2</artifactId>
  9.         </exclusion>
  10.     </exclusions>
  11. </dependency>

-

-

-

- 完毕

发表评论

表情：
评论列表 （有 0 条评论，206人围观）

还没有评论，来说两句吧...

相关阅读