springboot多环境配置logback的详细介绍

一、logback的介绍

Logback是由log4j创始人设计的另一个开源日志组件,官方网站: http://logback.qos.ch。它分为下面下个模块:
1.logback-core:是其它模块的基础设施,其它模块基于它构建,logback-core 提供了一些关键的通用机制
2.logback-classic:它是log4j的一个改良版本,同时它完整实现了slf4j API,使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging
3.logback-access:它与Servlet容器(如Jetty或Tomcat)集成在一起,以提供丰富而强大的HTTP-access日志功能。由于logback-access是初始设计的一部分,因此您喜欢的所有logback-classic功能也可以在logback-access中使用。

二、logback取代log4j的理由:

1.更快的实现:Logback可以在一些关键执行路径上性能提升10倍以上。不仅性能提升了,初始化内存加载也更小了。

2.非常充分的测试:Logback经过了几年,数不清小时的测试。Logback的测试是完全不同级别的。

3.非常充分且不断更新的文档

4.Logback-classic非常自然实现了SLF4j:Logback-classic实现了SLF4j。在使用SLF4j中,你都感觉不到logback-classic。而且因为logback-classic非常自然地实现了slf4j , 所 以切换到log4j或者其他,非常容易,只需要提供成另一个jar包就可以,根本不需要去动那些通过SLF4JAPI实现的代码。

5.自动重新加载配置文件,Logback-classic可以在修改后自动重新加载其配置文件。扫描过程快速,无争用,并且动态扩展到每秒数百个线程,遍及数百个线程。它还可以播放中的应用服务器以及更一般地内的JEE环境,它并没有涉及扫描一个单独的线程的创建

6.Lilith是用于登录的日志记录和访问事件查看器。它与log4j的差不多,不同之处在于Lilith旨在处理大量的日志数据而不会退缩。

7.有谨慎的模式: 在谨慎模式下,FileAppender在多个JVM上运行的多个实例可以安全地写入同一日志文件。在某些限制下,谨慎模式扩展到 RollingFileAppender。

8.从I / O故障中顺利恢复:LogbackFileAppender及其所有子类(包括RollingFileAppender)可以从I / O故障中正常恢复。因此,如果文件服务器暂时出现故障,则不再需要重新启动应用程序即可使日志再次工作。一旦文件服务器恢复正常,相关的logback附加程序将透明地从先前的错误情况中快速恢复。

9.配置文件可以处理不同的情况:开发人员经常需要在针对不同环境(例如开发,测试和生产)的多个logback配置文件之间进行切换。这些配置文件有很多共同点,仅在几个地方有所不同。为避免重复,支持的logback的配置文件条件处理的帮助下 ,和 元件,使得一个配置文件能充分瞄准几个环境。

10.Filters(过滤器)有些时候,需要诊断一个问题,需要打出日志。在log4j,只有降低日志级别,不过这样会打出大量的日志,会影响应用性能。在Logback,你可以继续 保持那个日志级别而除掉某种特殊情况,如admin这个用户登录,她的日志将打在DEBUG级别而其他用户可以继续打在WARN级别。要实现这个功能只需加4行XML配置。可以参考MDCFIlter 。

11.SiftingAppender(一个非常多功能的Appender):它可以用来分割日志文件根据任何一个给定的运行参数。如,SiftingAppender能够区别日志事件跟进用户的Session,然后每个用户会有一个日志文件。

12.自动压缩已经打出来的log:RollingFileAppender在产生新文件的时候,会自动压缩已经打出来的日志文件。压缩是个异步过程,所以甚至对于大的日志文件,在压缩过程中应用不会受任何影响。

13.堆栈树带有包版本:Logback在打出堆栈树日志时,会带上包的数据。

14.自动去除旧的日志文件:通过设置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory属性,你可以控制已经产生日志文件的最大数量。只需将maxHistory属性设置为30,早于30天的归档日志文件将被自动删除。

三、日志级别

几种常见的日志级别由低到高分为:TRACE < DEBUG < INFO < WARN < ERROR < FATAL。
如何理解这个日志级别呢?如果项目中的日志级别设置为INFO,那么比它更低级别的日志信息就看不到了,即是TRACE、DEBUG的日志将会不显示。

四、配置文件详细介绍

1.configuration节点

这是一个根节点,其中的各个属性如下:
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。

<configuration scan="true" scanPeriod="60 seconds" debug="false">  

2.springProperty 节点

可以从配置文件中读取logging.path和level的值

<springProperty scope="context" name="logging.path"  source="logging.file.path"/>
    <springProperty scope="context" name="logging.level" source="logging.level.com.fg.system.modules"/>

3.property节点

标记一个上下文变量,属性有name和value,定义变量之后可以使用${}来获取。

 <property name="PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"/>

上面的value配置编码的含义如下:
%d{yyyy-MM-dd HH:mm:ss.SSS}——日志输出时间
%thread——输出日志的进程名字,这在Web应用以及异步任务处理中很有用
%-5level——日志级别,并且使用5个字符靠左对齐
%logger ——日志输出者的名字
%msg——日志消息
%n——平台的换行符

4.contextName节点

标识一个上下文名称,默认为default,一般不怎么用

  <contextName>logback</contextName>

5.springProfile 节点

用来隔离环境,name属性来控制具体的环境,只有相应的环境才能进入执行

 <springProfile name="dev">

6.appender节点

用来格式化日志输出节点,有两个属性name和class,class用来指定哪种输出策略,常用就是控制台输出策略和文件输出策略。
这个节点很重要,通常的日志文件需要定义三个appender,分别是控制台输出,常规日志文件输出,异常日志文件输出。

 <appender name=""  class="ch.qos.logback.core.rolling.RollingFileAppender">
 <!-- 如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true-->
        <append>true</append>

7.filter节点

日志输出拦截器,没有特殊定制一般使用系统自带的即可,但是如果要将日志分开,比如将ERROR级别的日志输出到一个文件中,将除了ERROR级别的日志输出到另外一个文件中,此时就要拦截ERROR级别的日志了。

 <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>error</level>
    </filter>

下面这种常用方式是过滤掉比INFO低的级别,可以用来做日志隔离

 <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>INFO</level>
        <!--如果命中了就接受 -->
        <onMatch>ACCEPT</onMatch>
        <!--如果没有命中就过滤 -->
        <onMismatch>DENY</onMismatch>
    </filter>

8.file节点

日志路径,用来指明日志文件的输出位置,可以是绝对路径也可以是相对路径,如果没有File 属性,那么只会使用FileNamePattern的文件路径规则,如果同时有和,那么当天日志是,明天会自动把今天的日志改名为今天的日期。就是说 的日志都是当天的。

 <file>
        ${
    
    logging.path}/fg-error.log
    </file>

9. rollingPolicy节点

日志回滚策略,在这里我们用了TimeBasedRollingPolicy,基于时间的回滚策略。

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

10.fileNamePattern节点

用来设置指定时间的日志归档

<FileNamePattern>${
    
    logging.path}/fg-error.log.%d{
    
    yyyy-MM-dd}</FileNamePattern>

11.maxHistory 节点

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

  <MaxHistory>30</MaxHistory>

12.totalSizeCap: 可选节点

用来指定日志文件的上限大小,例如设置为1GB的话,那么到了这个值,就会删除旧的日志

<totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>

13.encoder节点

输出日志格式化

 <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

14.pattern节点

输出日志的格式

 <pattern>${
    
    PATTERN}</pattern>

15.charset节点

输出日志的编码方式

 <charset>UTF-8</charset>
    </encoder>
</appender>
</springProfile>

16.logger节点

用来具体指明包的日志输出级别,它将会覆盖root的输出级别。
该节点有几个重要的属性如下:
name:指定的包名
level:可选,日志的级别
addtivity:可选,默认为true,将此logger的信息向上级传递,将有root节点定义日志打印。如果设置为false,将不会上传,此时需要定义一个appender-ref 节点才会输出。

<logger name=""   level=""  additivity="false">
        <appender-ref ref="" />
    </logger>

17.root节点

这是一个必须节点,用来指定基础的日志级别,只有一个level属性,默认值是DEBUG。
该节点可以包含零个或者多个元素,子节点是appender-ref,标记这个appender将会添加到这个logger中。

	 <root level="">
            <appender-ref ref=""/>
        </root>
</configuration>  

五、如何使用

Spring Boot默认的日志框架就是logback,所以就不用重新引入依赖了。在项目resource下新建一个logback-spring.xml,按上面的方式填写好要的内容,最后在项目里加入日志记录器private final Logger log= LoggerFactory.getLogger(MobileUserController.class);
然后在方法里就可以用log记录自己想要的记录了
在这里插入图片描述

想要配置多环境的话,在logback-spring.xml利用springProfile 节点包裹线上想要的appender节点和logger节点来进行隔离,这样只有在线上才会运行这些隔离的节点,最后通过项目里配置的多环境yml,spring: profiles:active: prod来切换环境即可
在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/qq_40136782/article/details/108862296
今日推荐