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日志并进行多维度分析。
相关文章
|
21天前
|
XML Java 数据格式
Spring IOC—基于XML配置Bean的更多内容和细节(通俗易懂)
Spring 第二节内容补充 关于Bean配置的更多内容和细节 万字详解!
119 18
Spring IOC—基于XML配置Bean的更多内容和细节(通俗易懂)
|
9天前
|
前端开发 Java Spring
关于spring mvc 的 addPathPatterns 拦截配置常见问题
关于spring mvc 的 addPathPatterns 拦截配置常见问题
|
22天前
|
Java 数据库连接 Maven
Spring基础1——Spring(配置开发版),IOC和DI
spring介绍、入门案例、控制反转IOC、IOC容器、Bean、依赖注入DI
Spring基础1——Spring(配置开发版),IOC和DI
|
25天前
|
运维 NoSQL Java
SpringBoot接入轻量级分布式日志框架GrayLog技术分享
在当今的软件开发环境中,日志管理扮演着至关重要的角色,尤其是在微服务架构下,分布式日志的统一收集、分析和展示成为了开发者和运维人员必须面对的问题。GrayLog作为一个轻量级的分布式日志框架,以其简洁、高效和易部署的特性,逐渐受到广大开发者的青睐。本文将详细介绍如何在SpringBoot项目中接入GrayLog,以实现日志的集中管理和分析。
104 1
|
1月前
|
IDE Java 开发工具
还在为繁琐的配置头疼吗?一文教你如何用 Spring Boot 快速启动,让开发效率飙升,从此告别加班——打造你的首个轻量级应用!
【9月更文挑战第2天】Spring Boot 是一款基于 Spring 框架的简化开发工具包,采用“约定优于配置”的原则,帮助开发者快速创建独立的生产级应用程序。本文将指导您完成首个 Spring Boot 项目的搭建过程,包括环境配置、项目初始化、添加依赖、编写控制器及运行应用。首先需确保 JDK 版本不低于 8,并安装支持 Spring Boot 的现代 IDE,如 IntelliJ IDEA 或 Eclipse。
87 5
|
2月前
|
Java 应用服务中间件 HSF
Java应用结构规范问题之配置Logback以仅记录错误级别的日志到一个滚动文件中的问题如何解决
Java应用结构规范问题之配置Logback以仅记录错误级别的日志到一个滚动文件中的问题如何解决
|
2月前
|
Java 应用服务中间件 HSF
Java应用结构规范问题之配置Logback以在控制台输出日志的问题如何解决
Java应用结构规范问题之配置Logback以在控制台输出日志的问题如何解决
|
2月前
|
Java 微服务 Spring
Spring Cloud全解析:配置中心之解决configserver单点问题
但是如果该configserver挂掉了,那就无法获取最新的配置了,微服务就出现了configserver的单点问题,那么如何避免configserver单点呢?
|
2月前
|
Java Spring 开发者
解锁 Spring Boot 自动化配置的黑科技:带你走进一键配置的高效开发新时代,再也不怕繁琐设置!
【8月更文挑战第31天】Spring Boot 的自动化配置机制极大简化了开发流程,使开发者能专注业务逻辑。通过 `@SpringBootApplication` 注解组合,特别是 `@EnableAutoConfiguration`,Spring Boot 可自动激活所需配置。例如,添加 JPA 依赖后,只需在 `application.properties` 配置数据库信息,即可自动完成 JPA 和数据源设置。这一机制基于多种条件注解(如 `@ConditionalOnClass`)实现智能配置。深入理解该机制有助于提升开发效率并更好地解决问题。
49 0
|
2月前
|
人工智能 Java Spring
Spring框架下,如何让你的日志管理像‘AI’一样智能,提升开发效率的秘密武器!
【8月更文挑战第31天】日志管理在软件开发中至关重要,不仅能帮助开发者追踪问题和调试程序,还是系统监控和运维的重要工具。在Spring框架下,通过合理配置Logback等日志框架,可大幅提升日志管理效率。本文将介绍如何引入日志框架、配置日志级别、在代码中使用Logger,以及利用ELK等工具进行日志聚合和分析,帮助你构建高效、可靠的日志管理系统,为开发和运维提供支持。
39 0
下一篇
无影云桌面