javascript
Spring Boot——日志配置
日志,通常不會(huì)在需求階段作為一個(gè)功能單獨(dú)提出來(lái),也不會(huì)在產(chǎn)品方案中看到它的細(xì)節(jié)。但是,這絲毫不影響它在任何一個(gè)系統(tǒng)中的重要的地位。
為了保證服務(wù)的高可用,發(fā)現(xiàn)問(wèn)題一定要即使,解決問(wèn)題一定要迅速,所以生產(chǎn)環(huán)境一旦出現(xiàn)問(wèn)題,預(yù)警系統(tǒng)就會(huì)通過(guò)郵件、短信甚至電話的方式實(shí)施多維轟炸模式,確保相關(guān)負(fù)責(zé)人不錯(cuò)過(guò)每一個(gè)可能的bug。
預(yù)警系統(tǒng)判斷疑似bug大部分源于日志。比如某個(gè)微服務(wù)接口由于各種原因?qū)е骂l繁調(diào)用出錯(cuò),此時(shí)調(diào)用端會(huì)捕獲這樣的異常并打印ERROR級(jí)別的日志,當(dāng)該錯(cuò)誤日志達(dá)到一定次數(shù)出現(xiàn)的時(shí)候,就會(huì)觸發(fā)報(bào)警。
try {調(diào)用某服務(wù)} catch(Exception e) {LOG.error("錯(cuò)誤信息", e);}所以日志至關(guān)重要,這篇就來(lái)介紹下在Spring Boot如何配置日志。
Spring Boot默認(rèn)日志系統(tǒng)
Spring Boot默認(rèn)使用LogBack日志系統(tǒng),如果不需要更改為其他日志系統(tǒng)如Log4j2等,則無(wú)需多余的配置,LogBack默認(rèn)將日志打印到控制臺(tái)上。
如果要使用LogBack,原則上是需要添加dependency依賴的
<groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId></pre>但是因?yàn)樾陆ǖ腟pring Boot項(xiàng)目一般都會(huì)引用spring-boot-starter或者spring-boot-starter-web,而這兩個(gè)起步依賴中都已經(jīng)包含了對(duì)于spring-boot-starter-logging的依賴,所以,無(wú)需額外添加依賴。
我們基于《沒(méi)做過(guò)大項(xiàng)目,但我會(huì)建大項(xiàng)目》中創(chuàng)建的項(xiàng)目,啟動(dòng)springboot-demo項(xiàng)目,可以看到打印的日志信息如下。
以上至默認(rèn)配置啟動(dòng)下的日志顯示情況,如果需要做一些定制的日志配置比如將日志存儲(chǔ)到文件等應(yīng)該如何配置,下面就通過(guò)幾個(gè)小問(wèn)題來(lái)看看Spring Boot下是如何解決這些問(wèn)題的。
如何在項(xiàng)目中打印日志
新建一個(gè)配置類(lèi)LogConfig,注入一個(gè)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);@Beanpublic Person logMethod() {LOG.info("==========print log==========");return new Person();} }運(yùn)行SpringBootDemoApplication,可以看到控制臺(tái)的日志
Spring Boot默認(rèn)的日志級(jí)別為INFO,這里打印的是INFO級(jí)別的日志所以可以顯示。
很多開(kāi)發(fā)者在日常寫(xiě)private static final Logger LOG = LoggerFactory.getLogger(LogConfig.class);總覺(jué)得后面的LogConfig.class可有可無(wú),因?yàn)殡S便寫(xiě)個(gè)其他類(lèi)也不會(huì)報(bào)錯(cuò),但是準(zhǔn)確編寫(xiě)class信息能夠提供快速定位日志的效率。
我們看到打印的日志內(nèi)容左側(cè)就是對(duì)應(yīng)的類(lèi)名稱,這個(gè)是通過(guò)private static final Logger LOG = LoggerFactory.getLogger(LogConfig.class);實(shí)現(xiàn)的。
如果將LogConfig.class換成xxx.class,輸出日志就會(huì)顯示對(duì)應(yīng)的xxx類(lèi)名。這樣聲明的好處就是方便定位日志。
如何將日志信息存儲(chǔ)到文件
在本機(jī)環(huán)境,我們習(xí)慣在控制臺(tái)看日志,但是線上我們還是要通過(guò)將日志信息保存到日志文件中,查詢?nèi)罩疚募纯伞?/p>
那么應(yīng)該如何配置才能將日志信息保存到文件呢?
在我們創(chuàng)建的springboot-demo項(xiàng)目中,resources目錄下有個(gè)application.properties文件(如果是application.yml文件也是同樣的道理,只是采用的不同的編寫(xiě)風(fēng)格而已)。添加如下配置
logging.path=/Users/jackie/workspace/rome/ logging.file=springbootdemo.loglogging.path
該屬性用來(lái)配置日志文件的路徑
logging.file
該屬性用來(lái)配置日志文件名,如果該屬性不配置,默認(rèn)文件名為spring.log
運(yùn)行SpringBootDemoApplication
可以看到在指定路徑下生成了springbootdemo.log文件,該文件內(nèi)容和控制臺(tái)打印內(nèi)容一致。
如果注釋logging.file=springbootdemo.log則生成默認(rèn)文件名spring.log
如何設(shè)置日志級(jí)別
日志級(jí)別總共有TRACE < DEBUG < INFO < WARN < ERROR < FATAL ,且級(jí)別是逐漸提供,如果日志級(jí)別設(shè)置為INFO,則意味TRACE和DEBUG級(jí)別的日志都看不到。
上例中我們打印了一個(gè)INFO級(jí)別的日志,因?yàn)镾pring Boot默認(rèn)級(jí)別就是INFO,如果我們改為WARN,是否還能看到這行日志信息。
logging.level
該屬性用于配置日志級(jí)別。
在applicaition.properties中添加
logging.level.root=warn這里是用的root級(jí)別,即項(xiàng)目的所有日志,我們也可以使用package級(jí)別,即指定包下使用相應(yīng)的日志級(jí)別,下面再看。
啟動(dòng)SpringBootDemoApplication
你沒(méi)看錯(cuò),這個(gè)項(xiàng)目是成功啟動(dòng)了,但是幾乎沒(méi)有內(nèi)容,這是因?yàn)橹按蛴〉娜罩炯?jí)別都是INFO,這里設(shè)置為WARN,所以INFO級(jí)別的日志都不顯示。
這里我們可以改動(dòng)root還是INFO級(jí)別,將指定包下的日志級(jí)別設(shè)置為WARN
logging.level.root=INFOlogging.level.com.jackie.springbootdemo.config=WARN啟動(dòng)SpringBootDemoApplication
可以看到除了LogConfig類(lèi)中的INFO級(jí)別的日志沒(méi)有打印出來(lái),其他的INFO級(jí)別的日志都正常輸出了。
如何定制自己的日志格式
在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%nlogging.pattern.console
該屬性用于定制日志輸出格式。
上述配置的編碼中,對(duì)應(yīng)符號(hào)的含義如下
%d{HH:mm:ss.SSS}——日志輸出時(shí)間%thread——輸出日志的進(jìn)程名字,這在Web應(yīng)用以及異步任務(wù)處理中很有用%-5level——日志級(jí)別,并且使用5個(gè)字符靠左對(duì)齊%logger- ——日志輸出者的名字%msg——日志消息%n——平臺(tái)的換行符啟動(dòng)SpringBootDemoApplication
總結(jié)
以上是生活随笔為你收集整理的Spring Boot——日志配置的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 第四范式“金融范”系列分享会第二期开课:
- 下一篇: gradle idea java ssm