Spring Boot系列——日志配置

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: Spring Boot系列——日志配置

日志,通常不会在需求阶段作为一个功能单独提出来,也不会在产品方案中看到它的细节。但是,这丝毫不影响它在任何一个系统中的重要的地位。

为了保证服务的高可用,发现问题一定要即使,解决问题一定要迅速,所以生产环境一旦出现问题,预警系统就会通过邮件、短信甚至电话的方式实施多维轰炸模式,确保相关负责人不错过每一个可能的bug。

预警系统判断疑似bug大部分源于日志。比如某个微服务接口由于各种原因导致频繁调用出错,此时调用端会捕获这样的异常并打印ERROR级别的日志,当该错误日志达到一定次数出现的时候,就会触发报警。

try {
    调用某服务
} catch(Exception e) {
    LOG.error("错误信息", e);
}

所以日志至关重要,这篇就来介绍下在Spring Boot如何配置日志。

Spring Boot默认日志系统

Spring Boot默认使用LogBack日志系统,如果不需要更改为其他日志系统如Log4j2等,则无需多余的配置,LogBack默认将日志打印到控制台上。

如果要使用LogBack,原则上是需要添加dependency依赖的

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

但是因为新建的Spring Boot项目一般都会引用spring-boot-starter或者spring-boot-starter-web,而这两个起步依赖中都已经包含了对于spring-boot-starter-logging的依赖,所以,无需额外添加依赖。

我们基于《没做过大项目,但我会建大项目》中创建的项目,启动springboot-demo项目,可以看到打印的日志信息如下。

16c4df8791180b69_tplv-t2oaga2asx-zoom-in-crop-mark_4536_0_0_0.gif

以上至默认配置启动下的日志显示情况,如果需要做一些定制的日志配置比如将日志存储到文件等应该如何配置,下面就通过几个小问题来看看Spring Boot下是如何解决这些问题的。

如何在项目中打印日志

新建一个配置类LogConfig,注入一个Bean,并在方法中打印日志

package com.jackie.springbootdemo.config;
import com.jackie.springbootdemo.model.Person;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration public class LogConfig {
    private static final Logger LOG = LoggerFactory.getLogger(LogConfig.class);
    @Bean
 public Person logMethod() {
        LOG.info("==========print log==========");
        return new Person();
    }

运行SpringBootDemoApplication,可以看到控制台的日志

[ost-startStop-1] ]o.s.b.w.servlet.ServletRegistrationBean  Servlet dispatcherServlet mapped to [/] 
[ost-startStop-1]0.s.b.w.servlet.FilterRegistrationBean Mapping filter: 'characterEncodingFilter"to: [/*  
[ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean  Mapping filter: 'hiddenHttpMethodFilter’to: [/*]  
[ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean  Mapping filter:"httpPutFormContentFilterto: [ 
[ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean  Mapping filter: 'requestContextFilter" to: [/*] 
main] c.i.springbootdemo.config.LogConfig ==+=print log==== 
main] o.s.w.s.handler.SimpleUrlHandlerMapp  Mapped URL path [/**/fal.con.ico] onto handler of 
main] s.w.s.m.m.a.RequestMappingHandlerAdapter  Looking for aControllerAdvice:org.springframewor  
main] s.w.s.m.m.a.RequestMappingHandlerMapping:Mapped"{I/index],methods=[GET]}" onto public jav main] s.w.s.m.m.a.RequestMappingHandlerMapping:Mapped "{[/error]}" onto public org.springframewo main] s.w.s.m.m.a.RequestMappingHandlerMapping:Mapped "{[/error],produces=[text/html]}" onto pub
main] o.s.w.s.handler.SimpleUrlHandlerMapping :Mapped URL path [/webjars/**] onto handler of type 
main] o.s.w.s.handler.SimpleUrlHandlerMapping Mapped URL path [/**] onto handler of type [class 
main] o.s.i.e.a.AnnotationMBeanExporter Registering beans for jMX exposure on startup 
main] o.s.b.w.embedded.tomcat.TomcatWebServer Tomcat started on port(s): 8080 (http) with contex  
main] c.j.s.SpringbootDemoApplication :Started SpringbootDemoApplication in 2492second

Spring Boot默认的日志级别为INFO,这里打印的是INFO级别的日志所以可以显示。

很多开发者在日常写private static final Logger LOG = LoggerFactory.getLogger(LogConfig.class);总觉得后面的LogConfig.class可有可无,因为随便写个其他类也不会报错,但是准确编写class信息能够提供快速定位日志的效率。

我们看到打印的日志内容左侧就是对应的类名称,这个是通过private static final Logger LOG = LoggerFactory.getLogger(LogConfig.class);实现的。

如果将LogConfig.class换成xxx.class,输出日志就会显示对应的xxx类名。这样声明的好处就是方便定位日志。

如何将日志信息存储到文件

在本机环境,我们习惯在控制台看日志,但是线上我们还是要通过将日志信息保存到日志文件中,查询日志文件即可。

那么应该如何配置才能将日志信息保存到文件呢?

在我们创建的springboot-demo项目中,resources目录下有个application.properties文件(如果是application.yml文件也是同样的道理,只是采用的不同的编写风格而已)。添加如下配置

logging.path=/Users/jackie/workspace/rome/ 
logging.file=springbootdemo.log

logging.path

该属性用来配置日志文件的路径

logging.file

该属性用来配置日志文件名,如果该属性不配置,默认文件名为spring.log

运行SpringBootDemoApplication

16c4df8792acdeb5_tplv-t2oaga2asx-zoom-in-crop-mark_4536_0_0_0.gif

可以看到在指定路径下生成了springbootdemo.log文件,该文件内容和控制台打印内容一致。

如果注释logging.file=springbootdemo.log则生成默认文件名spring.log

16c4df8791f9a470_tplv-t2oaga2asx-zoom-in-crop-mark_4536_0_0_0.gif

如何设置日志级别

日志级别总共有TARCE < DEBUG < INFO < WARN < ERROR < FATAL ,且级别是逐渐提供,如果日志级别设置为INFO,则意味TRACE和DEBUG级别的日志都看不到。

上例中我们打印了一个INFO级别的日志,因为Spring Boot默认级别就是INFO,如果我们改为WARN,是否还能看到这行日志信息。

logging.level

该属性用于配置日志级别。

在applicaition.properties中添加

logging.level.root=warn

这里是用的root级别,即项目的所有日志,我们也可以使用package级别,即指定包下使用相应的日志级别,下面再看。

启动SpringBootDemoApplication

/Library/Java/JavaVirtualMachines/jdk1.8.0_121.jdk/Contents/Home/bin/java ...
objc[2728]:ClassJavaLaunchHelper isimplemented in both /Library/Java/JavaVirtualMachines/id

683305620564839130.jpg

你没看错,这个项目是成功启动了,但是几乎没有内容,这是因为之前打印的日志级别都是INFO,这里设置为WARN,所以INFO级别的日志都不显示。

这里我们可以改动root还是INFO级别,将指定包下的日志级别设置为WARN

logging.level.root=INFO
logging.level.com.jackie.springbootdemo.config=WARN

启动SpringBootDemoApplication

main] c.j.s.SpringbootDemoApplication :Starting SpringbootDemoApplication on jackie.local with PI 
main] c.j.s.SpringbootDemoApplication :No active profile set, falling back to default profiles: d 
mainConfigServletWebServerApplicationContext:Refreshingorgspringframework.boot.web.servlet.context.An
main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s):8080(http)  
main] o.apache.catalina.core.StandardService  Starting service [Tomcat] 
main  org.apache.catalina.core.StandardEngine Starting Servlet Engine: Apache Tomcat/8.5.32 
ost-startStop-1]  o.a.catalina.core.AprLifecycleListener  The APR based Apache Tomcat Native library which allows op  
ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/] Initializing Spring embedded WebApplicationContext  
ost-startStop-1] o.s.web.context.ContextLoader  Root WebApplicationContext: initialization completed in 14  
ost-startStop-1] o.s.b.w.servlet.ServletRegistrationBean  Servlet dispatcherServlet mapped to [/] 
ost-startStop-1]  o.s.b.w.servlet.FilterRegistrationBean  Mapping filter: 'characterEncodingFilter’to: [/*] 
ost-startStop-1]  o.s.b.w.servlet.FilterRegistrationBean  Mapping filter:'hiddenHttpMethodFilterto:[/*] 
ost-startStop-1]  o.s.b.w.servlet.FilterRegistrationBean  Mapping filter: 'httpPutFormContentFilter'to: [/*]  
ost-startStop-1]  o.s.b.w.servlet.FilterRegistrationBean  Mapping filter: 'requestContextFilter"to: [/*]  
main] o.s.w.s.handler.SimpleUrlHandlerMapping :Mapped URL path [/**/favicon.ico] onto handler of type [cl 
main] S.w.s.m.m.a.ReauestMapoingHandlerAdapter:lookingfor aControllerAdvice: ora.springframework.boot.we main]s.w.s.m.m.a.RequestMappingHandlerMappina:Mapped"{[/index],methods=[GET]}" onto public java.lang.St main. s.w.s.m.m.a.RequestMappingHandlerMapping:Mapped"{[/error]}" onto public org.springframework.http.R main] s.w.s.m.m.a.RequestMappingHandlerMapping:Mapped"{[/error],produces=[text/html]}" onto public org.s
main] o.s.w.s.handler.SimpleUrlHandlerMapping Mapped URL path webiars/** onto handler of type Iclass  
main] o.s.w.s.handler.SimpleUrlHandlerMapping :Mapped URL path //** onto handler of type Iclassorg.spri 
main] o.s.j.e.a.AnnotationMBeanExporter Registering beans for JMX exposure on startup 
main] o.s.b.w.embedded.tomcat.TomcatWebServer :Tomcat started on port(s): 8080 (http) with context path 
main] c.j.s.SpringbootDemoApplication :Started SpringbootDemoApplication in 2.642 secands(JVMr

可以看到除了LogConfig类中的INFO级别的日志没有打印出来,其他的INFO级别的日志都正常输出了。

如何定制自己的日志格式

在application.properties中添加

logging.pattern.console=%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n 
logging.pattern.file=%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n

logging.pattern.console

该属性用于定制日志输出格式。

上述配置的编码中,对应符号的含义如下

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

启动SpringBootDemoApplication

[main]INF0 com.jackie.springbootdemo.SpringbootDemoApplication-Starting SpringbootDemoApplication on jackie.local with PID 2847 (/Users[main]INFOcom.jackie.springbootdemo.SpringbootDemoApplication- No active profile set, falling back to default profiles: default
main】INFoorg.springframework.boot.web.servle.context.AnnotationConfigServletWebServerApplicationContext- Refreshing org.springframewo[main]INF0org.springframework.boot.web.embedded.tomcat.TomcatWebServer- Tomcat initialized with port(s): 8080 (http)[main]INFoorgapachecatalina.core.StandardService- Starting service [Tomcat]
mainINFoorgapachecatalinacoreStandardEnaine Starting Servlet Enaine: Apache Tomcat/8.5.32
localhost-startStop-1INF0org.apache.catalina.core.AprLifecycleListener-TheAPR based Apache Tomcat Native library which allows optim localhost-startStoo-11INF0orgapache.catalinacore.ContainerBaseTomcatlocalhost][/-Initializing Soring embedded WebAoplication localhost-startStop-1] INFO orgspringframework.web.context.ContextLoaderRootWebApplicationContext: initialization completed in 1501[localhost-startStop-1] INFO org.springframework.boot.web.servlet.ServletRegistrationBean- Servlet dispatcherServlet mapped to[]
localhost-startStop-1】INF0org.springframework.boot.web.servlet.FilterRegistrationBean-Mapping filter:'characterEncodingFilter’to:( localhost-startStop-1)INF0org.springframework.boot.web.servlet.FilterRegistrationBean-Mapping filter:'hiddenHttpMethodFilter’ to: [/ localhost-startStop-1INFOorg.springframework.boot.web.servlet.FilterRegistrationBean-Mapping filter:'httpPutFormContentFilter’ to: localhost-startStop-1)INF0org:soringframework.bootwebservletFilterReaistrationBean- Maoping filter: requestContextFilter’to: [/* mainINFOorg.springframework.web.servlet.handlerSimpleUrlHandlerMapping-MappedURL path[/**/favicon.ico] onto handler of type Iclas[main]INFoorg.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter- Looking for @ControllerAdvice: org.spring main]INF0ora.sorinaframework.web.servlet,mvc.method.annotation.ReauestMappingHandlerMapping- Mapped "{[/indexl,methods=[GET1Y" onto pu[main]INF0org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping- Mapped "{[/error]}" onto public org.spring[main]INF0org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping-Mapped "{[/error],produces=[text/html]}" mainINFoorgsoringramework.web.servlet.handler.SimpleUrlHandlerMapping-MappedURL path(/webiars/** onto handler of tvpe class on ImainINFOorg.springframework.web.servlet.handler.SimpleUrlHandlerMapping-MappedURL path [/**] onto handler of type [class org.spring[main]INFOorg.springframework.jmx.export.annotation.AnnotationMBeanExporter- Registering beans for JMX exposure on startup
[main]INFOorg.springframework.boot.web.embedded.tomcat.TomcatWebServer-Tomcat started on port(s): 8080 (http) with context path '
[main]INF0com.jackie.springbootdemo.SpringbootDemoApplication-StartedSpringbootDemoApplication in 2.903 seconds (JVM runningfor3.86

限于篇幅,还有相关特性,这里不一一陈述了。


相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
1月前
|
XML Java 测试技术
Spring IOC—基于注解配置和管理Bean 万字详解(通俗易懂)
Spring 第三节 IOC——基于注解配置和管理Bean 万字详解!
138 26
|
2天前
|
数据库连接 测试技术 Windows
【YashanDB知识库】windows配置ODBC跟踪日志, 使用日志定位问题
【YashanDB知识库】windows配置ODBC跟踪日志, 使用日志定位问题
|
3月前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
196 73
|
2月前
|
XML Java 应用服务中间件
Spring Boot 两种部署到服务器的方式
本文介绍了Spring Boot项目的两种部署方式:jar包和war包。Jar包方式使用内置Tomcat,只需配置JDK 1.8及以上环境,通过`nohup java -jar`命令后台运行,并开放服务器端口即可访问。War包则需将项目打包后放入外部Tomcat的webapps目录,修改启动类继承`SpringBootServletInitializer`并调整pom.xml中的打包类型为war,最后启动Tomcat访问应用。两者各有优劣,jar包更简单便捷,而war包适合传统部署场景。需要注意的是,war包部署时,内置Tomcat的端口配置不会生效。
532 17
Spring Boot 两种部署到服务器的方式
|
2月前
|
监控 Java 数据库连接
Spring c3p0配置详解
在Spring项目中配置C3P0数据源,可以显著提高数据库连接的效率和应用程序的性能。通过合理的配置和优化,可以充分发挥C3P0的优势,满足不同应用场景的需求。希望本文的详解和示例代码能为开发者提供清晰的指导,帮助实现高效的数据库连接管理。
121 10
|
2月前
|
开发框架 运维 监控
Spring Boot中的日志框架选择
在Spring Boot开发中,日志管理至关重要。常见的日志框架有Logback、Log4j2、Java Util Logging和Slf4j。选择合适的日志框架需考虑性能、灵活性、社区支持及集成配置。本文以Logback为例,演示了如何记录不同级别的日志消息,并强调合理配置日志框架对提升系统可靠性和开发效率的重要性。
|
2月前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
103 8
|
3月前
|
Java Spring
【Spring配置相关】启动类为Current File,如何更改
问题场景:当我们切换类的界面的时候,重新启动的按钮是灰色的,不能使用,并且只有一个Current File 项目,下面介绍两种方法来解决这个问题。
|
3月前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
3月前
|
Java Spring
【Spring配置】创建yml文件和properties或yml文件没有绿叶
本文主要针对,一个项目中怎么创建yml和properties两种不同文件,进行配置,和启动类没有绿叶标识进行解决。