背景：

日志的作用：

boot项目集成logback：

一、单模块项目配置：

1、添加依赖

2、添加logback-spring.xml配置文件到resources目录下

3、接下来启动一下项目，就可以看到我们的日志已经区分等级打印了

二、多微服务项目集成logback共同一份配置：

1、将你的logback-spring.xml配置文件在nacos中创建出来

2、在项目的配置文件中添加logback文件读取的配置：

3、在logback-spring.xml配置文件中也需要修改一下

4、运行项目，可以看到运行了两个服务，log文件打出来也是按照各服务名称来区分目录的

背景：

在程序中写日志是一件非常重要，但是很容易被开发人员忽视的地方。写好程序的日志可以帮助我们大大减轻后期维护压力。在实际的工作中，开发人员往往迫于巨大时间压力，而写日志又是一个非常繁琐的事情，往往没有引起足够的重视。开发人员应在一开始就养成良好的日志撰写习惯，并且应在实际的开发工作中为写日志预留足够的时间。

日志的作用：

一般程序日志出自下面几个方面的需求：

记录用户操作的审计日志，甚至有的时候就是监管部门的要求。

快速定位问题的根源

追踪程序执行的过程。

追踪数据的变化

数据统计和性能分析

采集运行环境数据

一般在程序上线之后，一旦发生异常，第一件事就是要弄清楚当时发生了什么。用户当时做了什么操作，环境有无影响，数据有什么变化，是不是反复发生等，然后再进一步的确定大致是哪个方面的问题。确定是程序的问题之后再交由开发人员去重现、研究、提出解决方案。这时，日志就给我们提供了第一手的资料。

boot项目集成logback：

一、单模块项目配置：

1、添加依赖

<!--logback依赖-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

2、添加logback-spring.xml配置文件到resources目录下

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒；当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="10 seconds" debug="false">
  <contextName>logback</contextName>
  <property name="log.path" value="./logs/merit" />
  <!-- 彩色日志 -->
  <!-- 彩色日志依赖的渲染类 -->
  <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}}"/>
  <!--1. 输出到控制台-->
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>debug</level>
    </filter>
    <encoder>
      <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
      <!-- 设置字符集 -->
      <charset>UTF-8</charset>
    </encoder>
  </appender>
  <!--2. 输出到文档-->
  <!-- 2.1 level为 DEBUG 日志，时间滚动输出  -->
  <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 正在记录的日志文档的路径及文档名 -->
    <file>${log.path}/debug/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}/debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
      <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <maxFileSize>100MB</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>
  <!-- 2.2 level为 INFO 日志，时间滚动输出  -->
  <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <!-- 正在记录的日志文档的路径及文档名 -->
  <file>${log.path}/info/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}/info/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  <maxFileSize>100MB</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>
  <!-- 2.3 level为 WARN 日志，时间滚动输出  -->
  <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <!-- 正在记录的日志文档的路径及文档名 -->
  <file>${log.path}/warn/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}/warn/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  <maxFileSize>100MB</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>
  <!-- 2.4 level为 ERROR 日志，时间滚动输出  -->
  <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <!-- 正在记录的日志文档的路径及文档名 -->
  <file>${log.path}/error/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}/error/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  <maxFileSize>100MB</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>
  <!-- 4. 最终的策略 -->
  <!-- 4.1 开发环境:打印控制台-->
  <springProfile name="dev">
  <logger name="com.sdcm.pmp" level="debug"/>
</springProfile>
<root level="info">
  <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>
</configuration>

3、接下来启动一下项目，就可以看到我们的日志已经区分等级打印了；

二、多微服务项目集成logback共同一份配置：

如果项目是使用了微服务架构，将一个大项目拆分成多个模块之后，如果配置打日志区分等级的话，需要在每个模块的resources目录下添加一个这样的配置；这样太麻烦了，几个模块要求的打日志区分出来的等级以及保存策略是一样的，那么我们如何实现将logback-spring.xml文件复用呢？这里我使用的是nacos做的配置管理；

1、将你的logback-spring.xml配置文件在nacos中创建出来；

2、在项目的配置文件中添加logback文件读取的配置：

这里你在nacos上添加了logback的配置文件之后，上图中config的值最后读取出来实际就是logging-spring.xml的文件;

logging.config实际读取为：http://nacos服务所在的IP地址/nacos/v1/cs/config?group=文件所在的分组&tenant=文件所在的命名空间username=nacos服务的账号&password=nacos服务的账号&dataId=logback-spring.xml

3、在logback-spring.xml配置文件中也需要修改一下：

因为是将项目拆分成了多个模块，所以这里需要动态的获取一下每个服务的服务名；

logback-spring.xml的加载顺序早于springboot的application.yml (或application.properties) 配置文件所以在logback-spring.xml文件中使用<property>标签读不到application.yml（或application.properties）文件中的值。这里需要通过springProperty标签来引用：<springProperty name="APPLICATION_NAME" source="spring.application.name"/>

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒；当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="10 seconds" debug="false">
  <contextName>logback</contextName>
  <springProperty name="APPLICATION_NAME" source="spring.application.name"/>
  <property name="log.path" value="./logs/${APPLICATION_NAME}" />
  <!-- 彩色日志 -->
  <!-- 彩色日志依赖的渲染类 -->
  <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}}"/>
  <!--1. 输出到控制台-->
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>debug</level>
    </filter>
    <encoder>
      <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
      <!-- 设置字符集 -->
      <charset>UTF-8</charset>
    </encoder>
  </appender>
  <!--2. 输出到文档-->
  <!-- 2.1 level为 DEBUG 日志，时间滚动输出  -->
  <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 正在记录的日志文档的路径及文档名 -->
    <file>${log.path}/debug/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}/debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
      <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <maxFileSize>100MB</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>
  <!-- 2.2 level为 INFO 日志，时间滚动输出  -->
  <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <!-- 正在记录的日志文档的路径及文档名 -->
  <file>${log.path}/info/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}/info/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  <maxFileSize>100MB</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>
  <!-- 2.3 level为 WARN 日志，时间滚动输出  -->
  <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <!-- 正在记录的日志文档的路径及文档名 -->
  <file>${log.path}/warn/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}/warn/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  <maxFileSize>100MB</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>
  <!-- 2.4 level为 ERROR 日志，时间滚动输出  -->
  <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <!-- 正在记录的日志文档的路径及文档名 -->
  <file>${log.path}/error/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}/error/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  <maxFileSize>100MB</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>
  <!-- 4. 最终的策略 -->
  <!-- 4.1 开发环境:打印控制台-->
  <springProfile name="dev">
  <logger name="com.sdcm.pmp" level="debug"/>
</springProfile>
  <root level="info">
  <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>
</configuration>

SpringBoot项目集成logback日志分等级配置

背景：

日志的作用：

boot项目集成logback：

一、单模块项目配置：

1、添加依赖

2、添加logback-spring.xml配置文件到resources目录下

3、接下来启动一下项目，就可以看到我们的日志已经区分等级打印了；

二、多微服务项目集成logback共同一份配置：

1、将你的logback-spring.xml配置文件在nacos中创建出来；

2、在项目的配置文件中添加logback文件读取的配置：

3、在logback-spring.xml配置文件中也需要修改一下：

4、运行项目，可以看到运行了两个服务，log文件打出来也是按照各服务名称来区分目录的：

热门文章

最新文章

相关课程

相关电子书

相关实验场景

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

SpringBoot项目集成logback日志分等级配置

背景：

日志的作用：

boot项目集成logback：

一、单模块项目配置：

1、添加依赖

2、添加logback-spring.xml配置文件到resources目录下

3、接下来启动一下项目，就可以看到我们的日志已经区分等级打印了；

二、多微服务项目集成logback共同一份配置：

1、将你的logback-spring.xml配置文件在nacos中创建出来；

2、在项目的配置文件中添加logback文件读取的配置：

3、在logback-spring.xml配置文件中也需要修改一下：

4、运行项目，可以看到运行了两个服务，log文件打出来也是按照各服务名称来区分目录的：

热门文章

最新文章

相关课程

相关电子书

相关实验场景