springboot日志1

Time。时光      2022-04-10     708

关键词:

Spring Boot在所有内部日志中使用Commons Logging,但是默认配置也提供了对常用日志的支持,如:Java Util LoggingLog4JLog4J2Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。
 
Logback是log4j框架的作者开发的新一代日志框架,它效率更高、能够适应诸多的运行环境,同时天然支持SLF4J。SpringBoot默认使用Logback
技术分享图片
 

从上图可以看到,日志输出内容元素具体如下:

  • 时间日期:精确到毫秒
  • 日志级别:ERROR, WARN, INFO, DEBUG or TRACE
  • 进程ID
  • 分隔符:- - - 标识实际日志的开始
  • 线程名:方括号括起来(可能会截断控制台输出)
  • Logger名:通常使用源代码的类名
  • 日志内容

日志依赖

  1.  
    <dependency>
  2.  
    <groupId>org.springframework.boot</groupId>
  3.  
    <artifactId>spring-boot-starter-logging</artifactId>
  4.  
    </dependency>
但是呢,实际开发中我们不需要直接添加该依赖,你会发现spring-boot-starter其中包含了 spring-boot-starter-logging,该依赖内容就是 Spring Boot 默认的日志框架 logback。
 

控制台输出

日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。
Spring Boot中默认配置ERRORWARNINFO级别的日志输出到控制台。您还可以通过启动您的应用程序–debug标志来启用“调试”模式(开发的时候推荐开启),以下两种方式皆可:

  • 在运行命令后加入--debug标志,如:$ java -jar springTest.jar --debug
  • application.properties中配置debug=true,该属性置为true的时候,核心Logger(包含嵌入式容器、hibernate、spring)会输出更多内容,但是你自己应用的日志并不会输出为DEBUG级别。

文件输出

默认情况下,Spring Boot将日志输出到控制台,不会写到日志文件。如果要编写除控制台输出之外的日志文件,则需在application.properties中设置logging.file或logging.path属性。

  • logging.file,设置文件,可以是绝对路径,也可以是相对路径。如:logging.file=log/my.log(相对)或者/log/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
 

级别控制

所有支持的日志记录系统都可以在Spring环境中设置记录级别(例如在application.properties中)
格式为:’logging.level.* = LEVEL’

  • logging.level:日志级别控制前缀,*为包名或Logger名
  • LEVEL:选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

举例:

  • logging.level.com.gwd=DEBUGcom.gwd包下所有class以DEBUG级别输出
  • logging.level.root=WARN:root日志以WARN级别输出

自定义日志配置

由于日志服务一般都在ApplicationContext创建前就初始化了,它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根据不同的日志系统,你可以按如下规则组织配置文件名,就能被正确加载:

  • Logback:logback-spring.xmllogback-spring.groovylogback.xmllogback.groovy
  • Log4j:log4j-spring.propertieslog4j-spring.xmllog4j.propertieslog4j.xml
  • Log4j2:log4j2-spring.xmllog4j2.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下面即可。

如果你即想完全掌控日志配置,但又不想用logback.xml作为Logback配置的名字,可以通过logging.config属性指定自定义的名字:

 

logging.config=classpath:logging-config.xml
虽然一般并不需要改变配置文件的名字,但是如果你想针对不同运行时Profile使用不同的日
志配置,这个功能会很有用。

 

 

接下来我们来看下普通的logback-spring.xml例子

  1.  
    <?xml version="1.0" encoding="UTF-8"?>
  2.  
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
  3.  
    <contextName>logback</contextName>
  4.  
    <property name="log.path" value="E: estlogback.log" />
  5.  
    <!--输出到控制台-->
  6.  
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
  7.  
    <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  8.  
    <level>ERROR</level>
  9.  
    </filter>-->
  10.  
    <encoder>
  11.  
    <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
  12.  
    </encoder>
  13.  
    </appender>
  14.  
     
  15.  
    <!--输出到文件-->
  16.  
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
  17.  
    <file>${log.path}</file>
  18.  
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  19.  
    <fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
  20.  
    </rollingPolicy>
  21.  
    <encoder>
  22.  
    <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
  23.  
    </encoder>
  24.  
    </appender>
  25.  
     
  26.  
    <root level="info">
  27.  
    <appender-ref ref="console" />
  28.  
    <appender-ref ref="file" />
  29.  
    </root>
  30.  
     
  31.  
    <!-- logback为java中的包 -->
  32.  
    <logger name="com.dudu.controller"/>
  33.  
    <!--logback.LogbackDemo:类的全路径 -->
  34.  
    <logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
  35.  
    <appender-ref ref="console"/>
  36.  
    </logger>
  37.  
    </configuration>


 

 

根节点<configuration>包含的属性

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

 

根节点<configuration>的子节点:
<configuration>下面一共有2个属性,3个子节点,分别是:

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

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

 

<contextName>logback</contextName>

 

属性二:设置变量<property>

用来定义变量值的标签, 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。

<property name="log.path" value="E:logback.log" />

子节点一<appender>

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

#####控制台输出ConsoleAppender:

  1.  
    <!--输出到控制台-->
  2.  
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
  3.  
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  4.  
    <level>ERROR</level>
  5.  
    </filter>
  6.  
    <encoder>
  7.  
    <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
  8.  
    </encoder>
  9.  
    </appender>

<encoder>表示对日志进行编码:

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

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

输出到文件RollingFileAppender
另一种常见的日志输出到文件,随着应用的运行时间越来越长,日志也会增长的越来越多,将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志:
  1.  
    <!--输出到文件-->
  2.  
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
  3.  
    <file>${log.path}</file>
  4.  
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  5.  
    <fileNamePattern>logback.%d{yyyy-MM-dd}.log</fileNamePattern>
  6.  
    <maxHistory>30</maxHistory>
  7.  
    <totalSizeCap>1GB</totalSizeCap>
  8.  
    </rollingPolicy>
  9.  
    <encoder>
  10.  
    <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
  11.  
    </encoder>
  12.  
    </appender>

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

子节点二<root>

root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性。

  • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。
    默认是DEBUG。
    可以包含零个或多个元素,标识这个appender将会添加到这个loger。
  1.  
    <root level="debug">
  2.  
    <appender-ref ref="console" />
  3.  
    <appender-ref ref="file" />
  4.  
    </root>

子节点三<loger>

<loger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender><loger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。

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

loger在实际使用的时候有两种情况
先来看一看代码中如何使用

  1.  
    package com.dudu.controller;
  2.  
    @Controller
  3.  
    public class LearnController {
  4.  
    private Logger logger = LoggerFactory.getLogger(this.getClass());
  5.  
     
  6.  
    @RequestMapping(value = "/login",method = RequestMethod.POST)
  7.  
    @ResponseBody
  8.  
    public Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){
  9.  
    //日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出。
  10.  
    logger.trace("日志输出 trace");
  11.  
    logger.debug("日志输出 debug");
  12.  
    logger.info("日志输出 info");
  13.  
    logger.warn("日志输出 warn");
  14.  
    logger.error("日志输出 error");
  15.  
    Map<String,Object> map =new HashMap<String,Object>();
  16.  
    String userName=request.getParameter("userName");
  17.  
    String password=request.getParameter("password");
  18.  
    if(!userName.equals("") && password!=""){
  19.  
    User user =new User(userName,password);
  20.  
    request.getSession().setAttribute("user",user);
  21.  
    map.put("result","1");
  22.  
    }else{
  23.  
    map.put("result","0");
  24.  
    }
  25.  
    return map;
  26.  
    }
  27.  
    }

这是一个登录的判断的方法,我们引入日志,并且打印不同级别的日志,然后根据logback-spring.xml中的配置来看看打印了哪几种级别日志。

第一种:带有loger的配置,不指定级别,不指定appender

1
<logger name="com.dudu.controller"/>

 

<logger name="com.dudu.controller" />将控制controller包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级的日志级别“info”;
没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
没有设置appender,此loger本身不打印任何信息。
<root level="info">将root的打印级别设置为“info”,指定了名字为“console”的appender。

当执行com.dudu.controller.LearnController类的login方法时,LearnController 在包com.dudu.controller中,所以首先执行<logger name="com.dudu.controller"/>,将级别为“info”及大于“info”的日志信息传递给root,本身并不打印;
root接到下级传递的信息,交给已经配置好的名为“console”的appender处理,“console”appender将信息打印到控制台;

打印结果如下:

1
16:00:17.407 logback [http-nio-8080-exec-8] INFO  com.dudu.controller.LearnController - 日志输出 info
16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日志输出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日志输出 error

 

第二种:带有多个loger的配置,指定级别,指定appender

1
2
3
4
<!--logback.LogbackDemo:类的全路径 -->
<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
    <appender-ref ref="console"/>
</logger>

 

控制com.dudu.controller.LearnController类的日志打印,打印级别为“WARN”;
additivity属性为false,表示此loger的打印信息不再向上级传递;
指定了名字为“console”的appender;

这时候执行com.dudu.controller.LearnController类的login方法时,先执行<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">,
将级别为“WARN”及大于“WARN”的日志信息交给此loger指定的名为“console”的appender处理,在控制台中打出日志,不再向上级root传递打印信息。
打印结果如下:

1
16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.dudu.controller.LearnController - 日志输出 warn
16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.dudu.controller.LearnController - 日志输出 error

 

当然如果你把additivity=”false”改成additivity=”true”的话,就会打印两次,因为打印信息向上级传递,logger本身打印一次,root接到后又打印一次。

多环境日志输出

据不同环境(prod:生产环境,test:测试环境,dev:开发环境)来定义不同的日志输出,在 logback-spring.xml中使用 springProfile 节点来定义,方法如下:

文件名称不是logback.xml,想使用spring扩展profile支持,要以logback-spring.xml命名

1
2
3
4
5
6
7
8
<!-- 测试环境+开发环境. 多个使用逗号隔开. -->
<springProfile name="test,dev">
    <logger name="com.dudu.controller" level="info" />
</springProfile>
<!-- 生产环境. -->
<springProfile name="prod">
    <logger name="com.dudu.controller" level="ERROR" />
</springProfile>

可以启动服务的时候指定 profile (如不指定使用默认),如指定prod 的方式为:
java -jar xxx.jar –spring.profiles.active=prod

 
原文链接 https://blog.csdn.net/gwd1154978352/article/details/78344091

























springboot.06.springboot日志管理(代码片段)

SpringBoot.06.SpringBoot日志管理SpringBoot日志介绍概念日志的级别日志的分类SpringBoot日志基本使用1.新建Module2.项目配置3.配置日志SpringBoot日志切割1.application.yml2.application-dev.yml3.logback-dev.xml4.测试SpringBoot日志介绍概念在SpringBoot框架中... 查看详情

springboot.06.springboot日志管理(代码片段)

SpringBoot.06.SpringBoot日志管理SpringBoot日志介绍概念日志的级别日志的分类SpringBoot日志基本使用1.新建Module2.项目配置3.配置日志SpringBoot日志切割1.application.yml2.application-dev.yml3.logback-dev.xml4.测试SpringBoot日志介绍概念在SpringBoot框架中... 查看详情

springboot系列springboot日志框架

注意:本SpringBoot系列文章基于SpringBoot版本v2.1.1.RELEASE进行学习分析,版本不同可能会有细微差别。前言Spring框架选择使用了JCL作为默认日志输出。而SpringBoot默认选择了SLF4J结合LogBack。那我们在项目中该使用哪种日志框架呢?在... 查看详情

springboot应用回顾(代码片段)

Springboot应用回顾1.SpringBoot应用回顾1.1约定优于配置1.2SpringBoot概念1.2.1什么是SpringBoot1.2.2SpringBoot主要特性1.3SpringBoot案例实现1.3.1案例实现1.3.2疑问1.4热部署1.4.1热部署实现演示1.4.2热部署原理分析1.4.3排除资源1.5全局配置文件1.5.1全... 查看详情

springboot日志2

 SpringBoot关于日志的官方文档1、简述SpringBoot官方文档关于日志的整体说明本博客基于SpringBoot_1.3.6大家请先简单看下这篇英文的官方文档,文中有说 SpringBoot 内部日志系统使用的是 CommonsLogging 并且 SpringBoot&... 查看详情

springboot日志1

SpringBoot在所有内部日志中使用CommonsLogging,但是默认配置也提供了对常用日志的支持,如:JavaUtilLogging,Log4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。 Logback是log4j框架的作者开发的新... 查看详情

springboot动态修改日志级别+权限认证

1.springboot动态修改日志级别+权限认证1.1.需求网上找到的动态修改日志级别的方式,基本都是没有权限验证的,或者特地关闭权限验证,但也没给出加上验证的解决方式修改日志等级也是一个敏感操作,最好不能暴露地址直接修... 查看详情

java日志框架--springboot中的日志使用(代码片段)

1.SpringBoot中的日志使用springboot框架在企业中的使用越来越普遍,springboot日志也是开发中常用的日志系统。springboot默认就是使用SLF4J作为日志门面,logback作为日志实现来记录日志。不懂日志框架和日志门面的请查看这篇... 查看详情

springboot系列springboot日志框架

注意:本SpringBoot系列文章基于SpringBoot版本 v2.1.1.RELEASE 进行学习分析,版本不同可能会有细微差别。前言Spring框架选择使用了JCL作为默认日志输出。而SpringBoot默认选择了SLF4J结合LogBack。那我们在项目中该使用哪种日志框... 查看详情

java日志框架--springboot中的日志使用(代码片段)

1.SpringBoot中的日志使用springboot框架在企业中的使用越来越普遍,springboot日志也是开发中常用的日志系统。springboot默认就是使用SLF4J作为日志门面,logback作为日志实现来记录日志。不懂日志框课和日志门面的请查看这篇... 查看详情

springboot知识点1

springboot:1.可以在pom文件中添加依赖sping-boot-properties-migrator来对项目进行升级,升级完成后,删除即可。2.关于日志的配置,参考:http://syllabus.lianmengtu.top/中关于日志的配置。可以显示日志所在行号对所有日志级别。3.可以在applic... 查看详情

springboot创建和使用(代码片段)

目录什么是SpringBootSpringBoot的优点SpringBoot项目的创建1、使用idea创建2、项目目录介绍和运行 SpringBoot配置文件 1、配置文件2、配置文件的格式3、properties3.1、properties基本语法 3.2、读取配置文件 3.3、缺点4、yml4.1、优点4.2、yml基... 查看详情

springboot中使用springaop实现日志记录功能

参考技术A一、创建日志注解1、日志类型枚举类2、自定义日志注解二、利用AOP实现日志切面统一处理1、日志实现类创建工厂2、切面类三、创建日志实现类1、添加日志接口2、添加日志接口实现类四、controller 查看详情

docker安装elk收集springboot日志(方法1)

参考技术A1、logstash中安装json_lines插件并重启logstash2、在SpringBoot项目pom.xml文件中添加logstash-logback-encoder依赖3、logback.xml文件添加配置,让logback的日志输出到logstash4、启动springboot应用5、使用kibana查看日志信息 查看详情

springboot与日志框架1(代码片段)

一、日志框架1.无论在什么系统,日志框架都是一个重要角色,所以理解和用好日志框架是相当重要的;像JDBC一样,日志框架分为接口层的门面和具体的实现组成。2.市面上的产品:2.1门面:SLF4J(SimpleLogginFacadeforJava)、JCL(JakartaCom... 查看详情

springboot参考教程日志相关使用

6.日志相关 SpringBoot默认使用logback日志,可用配置如下: 不再进行测试,具体使用方法在4.1.1中有详细介绍。在开发中一般使用log4j等日志,具体使用方法如下:1排除logback起步依赖  <dependency>    ... 查看详情

springboot整合aop日志管理(代码片段)

1.开发前准备1.1前置知识java基础自定义注解、反射SpringaopSpringBoot简单基础知识即可1.2环境参数开发工具:IDEA基础环境:Maven+JDK8所用技术:SpringBoot、lombok、mybatisplus、SpringaopSpringBoot版本:2.1.41.3涉及知识点自定义注解、反射spring... 查看详情

springboot日志

1、日志框架小张;开发一个大型系统;1、System.out.println("");将关键数据打印在控制台;去掉?写在一个文件?2、框架来记录系统的一些运行时信息;日志框架;zhanglogging.jar;3、高大上的几个功能?异步模式?自动归档?xxxx... 查看详情