SpringBoot自定义日志配置（生产环境-详解）：

最新推荐文章于 2024-06-11 10:35:13 发布
最新推荐文章于 2024-06-11 10:35:13 发布
阅读量9.8k 收藏 27
点赞数 16
分类专栏： springboot 文章标签： springboot log
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gexiaoyizhimei/article/details/93907932
版权

文章目录


SpringBoot项目创建后，便可以直接使用日志。默认打印在控制台。但有时我们需要自定义日志的级别，甚至希望不同包输出不同的日志级别。或者希望将日志信息保存到文件中，方便存档 。【见上一篇 SpringBoot中日志的简单使用。】

​ 在生产环境中，我们经常需要根据日期自动生成日志，并做备份，这就需要用logback-spring.xml文件做详细的配置。需要创建logback-spring.xml并放置到resource目录下。

自定义logback日志配置文件：
  • 日志配置模板一：简单配置（复制修改日志文件存储路径即可测试）
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!--property用于配置变量，可通过${LOG_PATH} 取对应的值-->
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_PATH" value="G:/iotLog2"/>
    <property name="PATTERN" value=""/>
    
    <contextName>logback</contextName>

    <!--输出到控制台，一个appender定义一种输出策略，可以定义多个-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--filter中定义要输出的日志级别，例如：输出info级别以上的日志，默认是info-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
        <!--日志输出编码格式化-->
        <encoder>
            <pattern>
             %d{yyyy-MM-dd} = [%thread] = %-5level = %logger{50} = %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!-- 输出到文件info，日期滚动记录 -->
 	<appender name="logInfoFile"
           class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--<Prudent>true</Prudent>-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!--过滤 其他只留info-->
            <level>info</level>
            <!--匹配到就禁止-->
            <onMatch>ACCEPT</onMatch>
            <!--没有匹配到就允许-->
            <onMismatch>DENY</onMismatch>
        </filter>
        <!--滚动策略，按照时间滚动 TimeBasedRollingPolicy 每天会生成一个日志文件-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--文件路径,定义了日志的切分方式,以防止日志填满整个磁盘空间-->
            <fileNamePattern>
                ${LOG_PATH}/info/iot-info-%d{yyyy-MM-dd}.log
            </fileNamePattern>
            <!--只保留最近90天的日志-->
            <maxHistory>90</maxHistory>
            <!--用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志-->
            <!--<totalSizeCap>1GB</totalSizeCap>-->
        </rollingPolicy>

        <append>true</append>

        <!--日志输出编码格式化-->
        <encoder>
            <charset>GBK</charset>
            <pattern>${PATTERN}</pattern>
        </encoder>
    </appender>

    <!--把上边的两种种输出策略添加到跟节点，名称要保证和上边一致，否则报错 ，并指明输出级别为INFO-->
    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="logInfoFile"/>
    </root>

    <!--可选节点，用来具体指明包的日志输出级别  如果不设置，则会交个root配置的appender处理-->
    <!--将该包下的日志交给console的appender处理，additivity设为false表示不再向上传递，如果置为true,则root接到后会再打印一次。 -->
    <logger name="com.iot.mqtt.controller" level="INFO" additivity="false">
    	<appender-ref ref="console"/>
    </logger>

</configuration>

控制台打印效果：

在这里插入图片描述

文件中打印效果：会生成一个info文件夹，日志文件名称根据日期生成。

在这里插入图片描述

配置文件logback-spring.xml节点详细介绍：

  • configuration：跟节点有以下属性

    • scan: 此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true
    • scanPeriod: 设置监测配置文件是否有修改的时间间隔,当scan为true时生效
    • debug: 当此属性设置为true时，将打印出logback内部日志信息.默认false

  • contextName: 设置日志上下文名称，可以通过%contextName来打印日志上下文名称

  • property： 可以用来定义变量，可以通过${name}来访问，有以下三个属性

    • name：名称
    • value：值
    • file: 用于指定配置文件的路径，如果你有多个配置信息，可以写在配置文件中，然后通过file引入

​ 例如：

<property file="G:/variables.properties" />

​ variables.properties如下:

LOG_PATH=G:/iotLog
PATTERN=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

  • appender: 格式化日志输出节点,可以配置多个。有两个属性name和class.
    name可以自定义，class指定输出策略，一般就是控制台和文件输出。apeender有以下子节点.

  • filter: 日志输出拦截器,一般使用系统提供的即可，祥见配置。

  • encoder： 和pattern节点组合用于具体输出的日志格式和编码方式。

  • file: 节点用来指明日志文件的输出位置，可以是绝对路径也可以是相对路径

  • rollingPolicy: 日志回滚策略，在这里我们用了TimeBasedRollingPolicy，基于时间的回滚策略,有以下子节点fileNamePattern，必要节点，可以用来设置指定时间的日志归档，例如我们上面的例子是每天将日志归档成一个zip包

  • maxHistory : 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件,，例如设置为30的话，则30天之后，旧的日志就会被删除

  • totalSizeCap: 可选节点，用来指定日志文件的上限大小，例如设置为3GB的话，那么到了这个值，就会删除旧的日志

  • root节点: 必选节点，用来指定最基础的日志输出级别，必须将定义的appender添加到该节点。

    <root level="info">
        <appender-ref ref="console"/>
        <appender-ref ref="logInfoFile"/>
</root>

  • logger节点:可选节点，用来具体指明包的日志输出级别，它将会覆盖root的输出级别

生产配置模板：（可以作为模板直接使用）

使用该配置会生成两个文件夹 info和error，分别存放info和error级别的日志文件，具体见配置文件。

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!--property用于配置变量，可通过${LOG_PATH} 取对应的值-->
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_PATH" value="G:/iotLog"/>
    <property name="PATTERN"
              value="%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n"/>
    <property name="CONSOLE_LOG_PATTERN"
              value="%date{yyyy-MM-dd HH:mm:ss} | %highlight(%5p) | %green(%thread) | %boldMagenta(%logger) | %cyan(%msg%n)"/>

    <contextName>logback</contextName>

    <!--输出到控制台，一个appender定义一种输出策略，可以定义多个-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--filter中定义要输出的日志级别，例如：输出info级别以上的日志，默认是info-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
        <!--日志输出编码格式化-->
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!-- 输出到文件info，日期滚动记录 -->
    <appender name="logInfoFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--<Prudent>true</Prudent>-->
        <!--如果只是想要 Info 级别的日志，只是过滤 info 还是会输出 Error 日志，因为 Error 的级别高，所以我们使用下面的策略，可以避免输出 Error 的日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!--过滤 其他只留info-->
            <level>info</level>
            <!--匹配到就禁止-->
            <onMatch>ACCEPT</onMatch>
            <!--没有匹配到就允许-->
            <onMismatch>DENY</onMismatch>
        </filter>
        <!--日志名称，如果没有File 属性，那么只会使用FileNamePattern的文件路径规则
               如果同时有<File>和<FileNamePattern>，那么当天日志是<File>，明天会自动把今天
               的日志改名为今天的日期。即，<File> 的日志都是当天的。-->
        <!--滚动策略，按照时间滚动 TimeBasedRollingPolicy 每天会生成一个日志文件-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间-->
            <fileNamePattern>${LOG_PATH}/info/iot-info-%d{yyyy-MM-dd}.log</fileNamePattern>
            <!--只保留最近90天的日志-->
            <maxHistory>90</maxHistory>
            <!--用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志-->
            <!--<totalSizeCap>1GB</totalSizeCap>-->
        </rollingPolicy>

        <append>true</append>

        <!--展示格式 layout-->
        <!--<layout class="ch.qos.logback.classic.PatternLayout">-->
            <!--<Pattern>${CONSOLE_LOG_PATTERN}</Pattern>-->
        <!--</layout>-->
        <!--日志输出编码格式化-->
        <encoder>
            <charset>GBK</charset>
            <pattern>${PATTERN}</pattern>
        </encoder>
    </appender>


    <!--输出到文件error，日期滚动记录 -->
    <appender name="logErrorFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!--只记录error-->
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_PATH}/error/iot-error-%d{yyyy-MM-dd}.log</FileNamePattern>
            <maxHistory>90</maxHistory>
        </rollingPolicy>

        <!--追加记录-->
        <append>true</append>

        <encoder>
            <charset>GBK</charset>
            <pattern>${PATTERN}</pattern>
        </encoder>
    </appender>


    <!--<root level="info,debug">-->
        <!--<appender-ref ref="console"/>-->
        <!--<appender-ref ref="logFile"/>-->
    <!--</root>-->

    <!--可选节点，用来具体指明包的日志输出级别 大小写无关-->
    <logger name="com.iot.mqtt.controller" level="INFO" additivity="false"/>


    <!--开发环境-->
    <springProfile name="dev">
        <!--必选节点，用来指定最基础的日志输出级别-->
        <root level="DEBUG">

            <appender-ref ref="logInfoFile"/>

            <appender-ref ref="logErrorFile"/>

            <appender-ref ref="console"/>

            <!--<appender-ref ref="DBAPPENDER"/>-->

        </root>

    </springProfile>

    <!--生产环境-->
    <springProfile name="pro">
        <!--必选节点，用来指定最基础的日志输出级别-->
        <root level="INFO">
            <appender-ref ref="logInfoFile"/>

            <appender-ref ref="logErrorFile"/>

            <appender-ref ref="console"/>

            <!--<appender-ref ref="DBAPPENDER"/>-->
        </root>

    </springProfile>








    <!--日志异步到数据库  -->

    <!--<appender name="DBAPPENDER" class="ch.qos.logback.classic.db.DBAppender">-->

    <!--<connectionSource class="ch.qos.logback.core.db.DataSourceConnectionSource">-->

    <!--<dataSource class="com.zaxxer.hikari.HikariDataSource">-->

    <!--<driverClassName>com.mysql.jdbc.Driver</driverClassName>-->

    <!--<jdbcUrl>jdbc:mysql://localhost:3306/albedo-new?useUnicode=true&amp;characterEncoding=utf8&amp;useSSL=false</jdbcUrl>-->

    <!--<username>root</username>-->

    <!--<password>123456</password>-->

    <!--<poolName>HikariPool-logback</poolName>-->

    <!--</dataSource>-->

    <!--</connectionSource>-->

    <!--&lt;!&ndash; 此日志文件只记录info级别的 &ndash;&gt;-->

    <!--<filter class="ch.qos.logback.classic.filter.LevelFilter">-->

    <!--<level>warn</level>-->

    <!--<onMatch>ACCEPT</onMatch>-->

    <!--<onMismatch>DENY</onMismatch>-->

    <!--</filter>-->

    <!--&lt;!&ndash; 此日志文件只记录info级别的 &ndash;&gt;-->

    <!--<filter class="ch.qos.logback.classic.filter.LevelFilter">-->

    <!--<level>error</level>-->

    <!--<onMatch>ACCEPT</onMatch>-->

    <!--<onMismatch>DENY</onMismatch>-->

    <!--</filter>-->

    <!--</appender>-->



</configuration>
总结：

要想配置出自己想要的日志格式和不同的输出策略，最重要的是要清楚配置文件各个节点的作用。更为详细的配置和节点功能，可以访问SpringBoot官网的日志配置和logback的相关配置 码字不易，路过的点个赞呗。

freesOcean
关注
  • 16
    点赞
  • 踩
  • 27
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
专栏目录
springboot学习总结系列（一）：多环境下（开发环境，生产环境）logback的配置（使用yml（properties同理），方便生产环境和开发环境的自由切换）
mayunju的博客
07-19 1016
本文主要讲解springboot项目下，如何通过修改一行配置文件，自由切换生产环境和开发环境logback的不同配置； 核心是解决了不同环境下由于对日志记录要求的不一样（日志级别、记录形式等）而需要不同配置的情况下，方便我们自由切换配置内容（至于logback的核心配置，这里不做赘述）； 一、首先我们创建一个标准的maven项目，引入springboot的相关依赖，这里不再赘述（可以参考htt...
canal-spring-boot-starter：springboot运河支持
02-13
canal-spring-boot-starter：springboot运河支持
Spring-boot-自定义LogbackAppender
最新发布
文天大人
06-11 260
怀念二抱三抱
springboot配置生产环境日志
浅海星星的博客
05-18 372
【代码】springboot配置生产环境日志。
SpringBoot2.x系列（二）生产环境日志及预警
weixin_41158378的博客
12-06 2055
在生产环境中，要求对日志进行分类切割及ERR异常类能及时预警，便于及时发现线上问题。 一、技术要求： (1).日志按照以天为单位存储，超过一定大小后要另起文件，便于查阅，日志可设置过期时间，过期后系统可自动删除，避免海量存储空间 (2) 出现线上ERROR级别异常，需要通过钉钉或者邮件及时预警 (3)把ERROR级别异常信息存储到数据库，方便线上查询 (4)要能方便区分除生产环境及开发环境，开发环境不需要邮件及钉钉预警 二、技术解决思路 对应生产环境异常错误预警，大概有两种解决方 （1）采用
SpringBoot中Log日志的集成详解
程序员小王的博客
12-26 3469
SpringBoot中Log日志的集成 一、日志的分类 1、名字分类 log4j ：log for java (因为for和4读音差不多，所以交log4j) logBack 日志说明 注意：springBoot默认集成了logback日志 2、日志分类 根日志：全局日志 rootLogger( springboot的日志级别：info) 子日志：包日志 logger 3、日志级别 OFF=》ERROR=》 WARNING=》INFO（springboot默认）=》DEBUG（mybatis默认级别）
springboot 日志设计结构
Leon_Jinhai_Sun的博客
05-07 625
SpringBoot中的日志使用 springboot框架在企业中的使用越来越普遍，springboot日志也是开发中常用的日志系统。springboot默认就是使用SLF4J作为日志门面，logback作为日志实现来记录日志。 SpringBoot中的日志设计 springboot中的日志 <dependency> <artifactId>spring-boo...
mzt-biz-log:支持Springboot，基于注解的可使用变量的通用操作日志组件
05-13
Springboot-注解-通用操作日志组件此组件解决的问题是： 「谁」在「什么时间」对「什么」做了「什么事」本组件目前针对 Spring-boot 做了 Autoconfig，如果是 SpringMVC，也可自己在 xml 初始化 beanChange Log版本...
SpringBoot默认日志配置说明
04-24
SpringBoot默认日志配置详解 在Java开发领域，Spring Boot以其简洁、快速的特性深受开发者喜爱。其中，日志管理是任何应用系统不可或缺的一部分，它帮助我们追踪代码执行过程，定位问题，以及进行性能分析。Spring ...
springboot-mybatisDemo:springboot-mybatisDemo
05-12
SpringBoot默认配置了很多功能，如Tomcat内嵌服务器、日志处理、健康检查等，开发者无需过多关注底层配置，能更专注于业务逻辑。 2. **MyBatis简介** MyBatis是一个优秀的持久层框架，它允许开发者编写动态SQL，...
springboot切面添加日志功能实例详解
08-25
本文将深入讲解如何利用Spring AOP（面向切面编程）来实现自定义的日志功能。 首先，我们需要创建一个新的Spring Boot项目。通过Spring Initializr或手动配置pom.xml文件，引入所需的依赖，确保Spring Web和Spring ...
logging level级别介绍
09-17
今天小编就为大家分享一篇logging level级别介绍，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
Spring Boot（四）之添加log配置
Widsom的博客
08-18 8492
Spring Boot（四）之添加log配置 1.在项目中创建一个logback.xml文件 文件内容如下： &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;configuration scan="false"&gt; &lt;!--设置logPath的变量，变量的值：/Webapp/springboot-mybatis-d...
spring-boot 中的 log 配置
wobenqingfeng的专栏
04-06 3494
在这里简单介绍下常用的配置参数日志级别机制：如果一条日志信息的级别大于等于配置文件的级别，就记录。trace：追踪，就是程序推进一下，可以写个trace输出 debug：调试，一般作为最低级别，trace基本不用。info：输出重要的信息，使用较多 warn：警告，有些信息不是错误信息，但也要给程序员一些提示。error：错误信息。用的也很多。fatal：致命错误。输出源CONSOLE（输出到控制台） FILE（输出到文件）格式。
Spring Boot Log配置
wangzhihao的博客
09-04 1110
日志 Spring Boot 使用 Commons Logging 进行所有内部日志记录，但保留底层日志实现。 Spring Boot 为 Java Util Logging，Log4J2 和 Logback 提供了默认配置。 在每种情况下，记录器都预先配置为使用控制台输出，同时还提供可选的文件输出。 默认情况下，如果使用 Starters，则使用Logback进行日志记录。还包括适当的Logback路由，以确保使用Java Util Logging，Commons Logging，Log4J或SLF4J的
Springboot log4j2过滤器appender级别
u014777076的博客
05-06 1090
为log4j2配置appender级别的过滤器，这是log4j2日志打印中，顺序执行的最后一条过滤器，过滤器执行后，将进入appender，完成日志打印 源码分析 以输出一条debug日志为例 log.debug("this is a debug log."); 程序将调用org.apache.logging.log4j.spi.AbstractLogger#debug(java.lang.St...
spring-boot 日志配置
阳光灿烂的中午
03-19 264
<?xml version="1.0" encoding="UTF-8"?> <!-- ##########当存在spring-boot-starter-web 这儿依赖包，就不需要再添加有关日志的依赖包了。 可复用的springboot日志配置文件，，， 自定义日志输出格式，输出位置， 保存天数等。 日志配置文件有默认的 几个命名： logback....
Springboot2整合logback.xml动态修改日志打印级别
z69183787的专栏
11-06 3402
今天找bug烦到了，生产上的日志级别不能修改，非常不利于排查问题，于是想到了动态修改日志打印级别，因为上一周把项目升级成springboot2，并且使用logback.xml管理日志打印，所以修改也很方便。 1.在pom.xml引入日志依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-s..
Logback配置详解——appender
微信公众号：一颗向上的草莓
05-18 2039
logback 常用配置详解（二）<appender> <appender>标签： <appender>是<configuration>的子节点，是负责写日志的组件。 <appender>有两个必要属性name和class。name指定appender名称，class指定appender的全限定名。 1.Console...
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值