Spring Boot的日志详解

日志框架的介绍

Logback是由log4j创始人设计的另一个开源日志组件,官方网站： http://logback.qos.ch。它当前分为下面下个模块：

  • logback-core：其它两个模块的基础模块
  • logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging
  • logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能
    Spring Boot默认使用的是Logback这个日志框架，一般而言，使用默认的就足够了，如果读者不习惯的话，只需要更换对应框架的Starter就足够了。

日志格式

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qvdAnJO9-1571216656991)(…/…/image/Logging格式.png)]

  • 日期时间：精确到毫秒
  • 日志级别：ERROR， WARN， INFO， DEBUG or TRACE
  • 进程 id
  • 分割符：用于区分实际的日志记录
  • 线程名：括在方括号中
  • 日志名字：通常是源类名
  • 日志信息

加入依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-logging</artifactId>
</dependency>

更改配置

  • application.properties
server.port=8888
spring.output.ansi.enabled=always
logging.level.org.springframework.web=warn
logging.level.root=INFO
logging.path=D:/java/log
logging.file.max-size=10MB
#写入文件的格式
#logging.pattern.file=
  • 控制台输出
    日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出。
    Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。您还可以通过启动您的应用程序–debug标志来启用“调试”模式（开发的时候推荐开启）
  • 文件输出
    默认情况下，Spring Boot将日志输出到控制台，不会写到日志文件。如果要编写除控制台输出之外的日志文件，则需在application.properties中设置logging.file或logging.path属性。

    • logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：logging.file=my.log
    • logging.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：logging.path=/var/log
      如果只配置 logging.file，会在项目的当前路径下生成一个 xxx.log 日志文件。

如果只配置 logging.path，在 /var/log文件夹生成一个日志文件为 spring.log
注：二者不能同时使用，如若同时使用，则只有logging.file生效
默认情况下，日志文件的大小达到10MB时会切分一次，产生新的日志文件，默认级别为：ERROR、WARN、INFO

logback的配置介绍

  • Logger、appender及layout
    　　Logger作为日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，也可以定义日志类型、级别。
    　　Appender主要用于指定日志输出的目的地，目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。
    　　Layout 负责把事件转换成字符串，格式化的日志信息的输出。

  • logger context
    　　各个logger 都被关联到一个 LoggerContext，LoggerContext负责制造logger，也负责以树结构排列各logger。其他所有logger也通过org.slf4j.LoggerFactory 类的静态方法getLogger取得。 getLogger方法以 logger名称为参数。用同一名字调用LoggerFactory.getLogger 方法所得到的永远都是同一个logger对象的引用。

  • 有效级别及级别的继承
    　　Logger 可以被分配级别。级别包括：TRACE、DEBUG、INFO、WARN 和 ERROR，定义于ch.qos.logback.classic.Level类。如果 logger没有被分配级别，那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。

  • 打印方法与基本的选择规则
    　　打印方法决定记录请求的级别。例如，如果 L 是一个 logger 实例，那么，语句 L.info("…")是一条级别为 INFO的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用，否则，称为被禁用。记录请求级别为 p，其 logger的有效级别为 q，只有则当 p>=q时，该请求才会被执行。
    该规则是 logback 的核心。级别排序为： TRACE < DEBUG < INFO < WARN < ERROR

自定义日志配置

由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。
根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

  • Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2：log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging)：logging.properties
    Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项（下面会提到）。
    上面是默认的命名规则，并且放在src/main/resources下面即可。
logging.config=classpath:logging-config.xml
  • 下面我们来看看一个普通的logback-spring.xml例子
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false"><contextName>spring-boot-logging</contextName><property name="logPath" value="log"/><!--输出到控制台--><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>%d{yyyy-MM-dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n</pattern></encoder></appender><!--输出到文件--><appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender"><!--<file>${logPath}/spring-boot-logging.log</file>--><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${logPath}/spring-boot-logging.%d{yyyy-MM-dd}.log.zip</fileNamePattern><!-- 日志保存周期 --><maxHistory>30</maxHistory><!-- 总大小 --><totalSizeCap>100KB</totalSizeCap></rollingPolicy><encoder><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern></encoder></appender><root level="INFO"><appender-ref ref="console"/><appender-ref ref="file"/></root><logger name="cn.andyoung.logback.controller" level="WARN"><appender-ref ref="console"/><appender-ref ref="file"/></logger>
</configuration>

logback.xml常用配置详解

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

根节点<configuration>的子节点：

<configuration>下面一共有2个属性，3个子节点，分别是：

属性一：设置上下文名称<contextName>

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用<contextName>设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改,可以通过%contextName来打印日志上下文名称。
<contextName>logback</contextName>

属性二：设置变量<property>

用来定义变量值的标签，<property> 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过<property>定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。
<property name="logPath" value="log"/>

子节点一<appender>

appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。

控制台输出ConsoleAppender：

<!--输出到控制台--><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>ERROR</level></filter><encoder><pattern>%d{yyyy-MM-dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n</pattern></encoder></appender>
  • <encoder>表示对日志进行编码：

    • %d{HH: mm:ss.SSS}——日志输出时间
    • %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
    • %-5level——日志级别，并且使用5个字符靠左对齐
    • %logger{36}——日志输出者的名字
    • %msg——日志消息
    • %n——平台的换行符

ThresholdFilter为系统定义的拦截器，例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉，不然你控制台会发现没日志~

FileAppender：把日志添加到文件，有以下子节点：

  • <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
  • <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
  • <encoder>：对记录事件进行格式化。（具体参数稍后讲解 ）
  • <prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

RollingFileAppender:滚动记录文件,先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件

另一种常见的日志输出到文件，随着应用的运行时间越来越长，日志也会增长的越来越多，将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志：

  • <file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。

  • <append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

  • <rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类

  • class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：

    • <fileNamePattern>：必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
    • <maxHistory>:
      可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

  • class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:

    • <maxFileSize>:这是活动文件的大小，默认值是10MB。
    • <prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
    • <triggeringPolicy>: 告知 RollingFileAppender 合适激活滚动。
    • class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根据固定窗口算法重命名文件的滚动策略。有以下子节点：
    • <minIndex>:窗口索引最小值
    • <maxIndex>:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
    • <fileNamePattern>:必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，

  • <encoder>：对记录事件进行格式化。负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。

  • PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个<pattern>节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“%”进行转义。

  • 还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这里就不详解了。
    大家可以参考官方文档（http://logback.qos.ch/documentation.html），还可以编写自己的Appender。

  • 子节点<loger>：用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。<loger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。
    可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger

    • name: 用来指定受此loger约束的某一个包或者具体的某一个类。
    • level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前loger将会继承上级的级别。
    • addtivity: 是否向上级loger传递打印信息。默认是true。同<loger>一样，可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger。

  • 子节点<root>:它也是<loger>元素，但是它是根loger,是所有<loger>的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。

    • level: 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，不能设置为INHERITED或者同义词NULL。 默认是DEBUG。

常用logger配置

<!--输出到文件--><appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${logPath}/spring-boot-logging.log</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${logPath}/spring-boot-logging.%d{yyyy-MM-dd}.log</fileNamePattern><!-- 日志保存周期 --><maxHistory>30</maxHistory><!-- 总大小 --><totalSizeCap>100KB</totalSizeCap></rollingPolicy><encoder><pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern></encoder></appender>

其中重要的是rollingPolicy的定义，上例中<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>定义了日志的切分方式——把每一天的日志归档到一个文件中，<maxHistory>30</maxHistory>表示只保留最近30天的日志，以防止日志填满整个磁盘空间。同理，可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。<totalSizeCap>1GB</totalSizeCap>用来指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志

说明：当天的日志会记录在spring-boot-logging.log文件里。昨天的日志会被转移到<fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>文件

demo获取,欢迎start

Springboot [日志管理LogBack]相关推荐

  1. 【笑小枫的SpringBoot系列】【六】SpringBoot日志打印Logback详解

    什么是Logback Logback 旨在作为流行的 log4j 项目的继承者,是SpringBoot内置的日志处理框架,spring-boot-starter其中包含了spring-boot-sta ...

  2. springboot日志管理+集成log4j

    java中Logger.getLogger(Test.class) log4的使用方法:  log4是具有日志记录功能,主要通过一个配置文件来对程序进行监测 有两种配置方式:一种程序配置,一种文件配置 ...

  3. Springboot日志框架Logback的使用及配置

    两种配置方式 application.properties或 application.yml (系统层面) logback-spring.xml(自定义文件方式) 第一种方式比较简单,可做的事情也比较 ...

  4. Springboot 日志管理模块编写记录

    /**配置类 **/@Component @Order(value=1) public class MyApplicationRunner implements ApplicationRunner{ ...

  5. SpringBoot (14)---日志配置(logback)

    SpringBoot 日志配置(logback) SpringBoot支持Java Util Logging,Log4J,Log4J2和Logback日志框架,默认采用logback日志.在实际Spr ...

  6. SpringBoot基础篇日志管理之logback配置文件

    1.美图 2.概述 SpringBoot默认选用logback进行日志管理,前一篇讲述了默认配置日志的参数,然而这些内容比较初级,并不一定能满足我们更加特殊的需求(比如输出到多个不同的配置文件,不同的 ...

  7. SpringBoot中使用log4j进行日志管理

    场景 SpringBoot项目中使用log4j进行日志管理. 实现 1.因为SpringBoot默认是使用logback,所以要修改pom.xml 过滤掉自带的spring-boot-starter- ...

  8. SpringBoot生成日志文件---logback和log4j

    SpringBoot生成日志文件---logback和log4j 一.logback logback是SpringBoot自带的日志文件,默认会为控制台输出INFO级别的日志,并且不会将日志文件保存. ...

  9. 超简单的Springboot中的日志管理配置

    本案例中可以了解,怎么配置日志的输出路径,输出格式(比如说zip格式),按日期进行划分(今天的日志输出为一个文件,明天的日志输出到另一个文件),在按日期划分的同时又按文件大小划分(比如说每天的日志记录 ...

最新文章

  1. Quzrtz 使用oracle集群无法正常启动问题解决
  2. 批处理start命令学习
  3. python turtle详细教程_python 中的turtle使用教程
  4. 二叉树节点为某一值的路径
  5. php的require 失败,PHP在require_once上失败
  6. jdk从1.8降到1.7的办法
  7. Hyrax: Doubly-efficient zkSNARKs without trusted setup学习笔记
  8. 服务器系统2008恢复,win2003升级为win2008、win2012保留数据重装恢复数据说明
  9. 亮度、对比度与饱和度
  10. MYSQL中出现 ERROR 1205 (HY000): Lock wait timeout exceeded; try restarting transaction的问题解决
  11. solidity-msg.sender到底是什么？
  12. 考研高危人群！你是否还在危险的边缘试探？
  13. 自定义数据集（Pokemon）实战
  14. 全球响应，维谛技术（Vertiv）助力EPC企业出海“加速度”
  15. 线程的生命周期以及java提供的方法
  16. 来自星星的宝贝，我要如何发现你？
  17. 【内网穿透】zerotier构建局域网，闲置电脑充当高性能服务器。
  18. Burpsuite破解用户名和密码
  19. 分享一个下载无损音乐的网站，且用且珍惜！
  20. 微服务开源框架TARS的RPC源码解析 之 初识TARS C++服务端

热门文章

  1. PNAS：微生物组分析揭示人类皮肤的独特性
  2. pandas使用groupby函数和cumsum函数计算每个分组内的数值累加值、并生成新的dataframe数据列（ cumulative sum of each group in dataframe
  3. R语言使用ggpubr包的ggbarplot函数可视化分组条形图（grouped bar plot）、并添加误差条（error bar、误差条显示平均值+/-sd）、不添加填充色、添加jitter抖动
  4. R语言使用for循环嵌套ggplot2可视化输出多个可视化结果实战
  5. R语言set.seed函数的意义及实战
  6. plotly基于dataframe数据绘制股票自定义K线图
  7. python代码获取今天、昨天、明天的日期
  8. 搭建linux下eclipse php完美搭建开发php,搭建linux上的Eclipse+PHP编程环境
  9. 服务器到底长什么样子啊(#ﾟДﾟ)?
  10. 三代测序原理与数据文件简介（SMRT+Nanopore）