面試官:聊一聊 Spring Boot 服務(wù)監(jiān)控機(jī)制
來源丨Java后端
Spring Boot來構(gòu)建,所以了解 SpringBoot 的監(jiān)控特性是非常有必要的,而 SpringBoot 也提供了一些特性來幫助我們監(jiān)控應(yīng)用。SpringBoot 2.3.1.RELEASE 版本演示。SpringBoot 中的監(jiān)控可以分為 HTTP 端點(diǎn)和 JMX 兩種方式來監(jiān)控當(dāng)前應(yīng)用的運(yùn)行狀況和指標(biāo)收集HTTP Endpoints 監(jiān)控
SpringBoot 包括許多內(nèi)置的端點(diǎn),并允許我們添加自己的端點(diǎn)??梢酝ㄟ^ HTTP 或 JMX 啟用或禁用每個(gè)端點(diǎn),并公開(使其可以遠(yuǎn)程訪問)。每個(gè)端點(diǎn)都有一個(gè)唯一的 id,訪問時(shí)可以通過如下地址進(jìn)行訪問:http:ip:port/{id}(SpringBoot 1.x ),而在 SpringBoot 2.x 版本中,默認(rèn)新增了一個(gè) /actuator 作為基本路,訪問地址則對(duì)應(yīng)為 :http:ip:port/actuator/{id}。HTTP 監(jiān)控非常簡(jiǎn)單,在 SpringBoot 項(xiàng)目中,引入如下依賴:<dependencies>
????<dependency>
????????<groupId>org.springframework.bootgroupId>
????????<artifactId>spring-boot-starter-actuatorartifactId>
????dependency>
dependencies>http:localhost:8080/actuator/health,訪問之后得到如下結(jié)果:
Spring Boot 中提供了非常多的默認(rèn)端點(diǎn)監(jiān)控,但是出于安全考慮,默認(rèn)情況下有些端點(diǎn)并不是開啟狀態(tài),如 shutdown 端點(diǎn)就是默認(rèn)關(guān)閉的。內(nèi)置端點(diǎn)
Spring Boot 中默認(rèn)提供的常用內(nèi)置端點(diǎn)如下:
health 和 info 端點(diǎn),所以如果需要允許端點(diǎn)對(duì)外暴露,可以通過如下配置(如果想要暴露所有的端點(diǎn),則可以直接配置 "*" ):management:
??endpoints:
????web:
??????exposure:
????????include: [health,info,mappings] //或者直接配置 "*"management.endpoint.<id>.enabled=truehealth 端點(diǎn)
health 斷點(diǎn)默認(rèn)只是展示當(dāng)前應(yīng)用健康信息,但是我們可以通過另一個(gè)配置打開詳細(xì)信息,這樣不僅僅會(huì)監(jiān)控當(dāng)前應(yīng)用,還會(huì)監(jiān)控與當(dāng)前應(yīng)用相關(guān)的其他第三方應(yīng)用,如 Redis。management:
??endpoint:
????health:
??????show-details: alwaysRedis 之后再次訪問 health 端點(diǎn),就可以展示 Redis 服務(wù)的健康信息了:
loggers 端點(diǎn)
http://localhost:8080/actuator/loggers 可以查看當(dāng)前應(yīng)用的日志級(jí)別等信息:
info,但是現(xiàn)在有一個(gè) bug 通過 info 級(jí)別無法排查,那么我們就可以臨時(shí)修改 log 級(jí)別。ROOT 節(jié)點(diǎn)是 info 級(jí)別,那么我們可以通過 postman 等工具來發(fā)一個(gè) post 請(qǐng)求修改日志級(jí)別。
info 變成了 debug:
metrics 端點(diǎn)
metrics 是一個(gè)非常重要的監(jiān)控端點(diǎn),其監(jiān)控內(nèi)容覆蓋了 JVM 內(nèi)存、堆、類加載、處理器和 tomcat 容器等一些重要指標(biāo):

自定義監(jiān)控端點(diǎn)
SpringBoot 提供的監(jiān)控非常強(qiáng)大,但是就算再全面的監(jiān)控也不可能滿足所有人的需求,所以 SpringBoot 也支持自定義監(jiān)控端點(diǎn)。自定義監(jiān)控端點(diǎn)常用注解
@Endpoint:定義一個(gè)監(jiān)控端點(diǎn),同時(shí)支持 HTTP和JMX兩種方式。@WebEndpoint:定義一個(gè)監(jiān)控端點(diǎn),只支持 HTTP方式。@JmxEndpoint:定義一個(gè)監(jiān)控端點(diǎn),只支持 JMX方式。
@ReadOperation:作用在方法上,可用來返回端點(diǎn)展示的信息(通過 Get方法請(qǐng)求)。@WriteOperation:作用在方法上,可用來修改端點(diǎn)展示的信息(通過 Post方法請(qǐng)求)。@DeleteOperation:作用在方法上,可用來刪除對(duì)應(yīng)端點(diǎn)信息(通過 Delete方法請(qǐng)求)。@Selector:作用在參數(shù)上,用來定位一個(gè)端點(diǎn)的具體指標(biāo)路由。
來,一起寫一個(gè)自己的監(jiān)控端點(diǎn)
定義一個(gè)類,并使用 @Endpoint注解標(biāo)注標(biāo)識(shí),同時(shí)定義幾個(gè)方法用@ReadOperation和@WriteOperation注解來標(biāo)注:
@Endpoint(id="myEndpoint")
@Component
public?class?MyEndpoint {
????private?String?STATUS = "up";
????private?String?DETAIL = "一切正常";
// @ReadOperation
// public String test1(){
// return "wolf";
// }
// @ReadOperation
// public Map test2(){
// Map map = new HashMap();
// map.put("status","up");
// return map;
// }
????@ReadOperation
????public?JSONObject test3(){
????????JSONObject jsonObject= new?JSONObject();
????????jsonObject.put("status",STATUS);
????????jsonObject.put("detail",DETAIL);
????????return?jsonObject;
????}
????@ReadOperation
????public?JSONObject test3_1(@Selector?String?name){
????????JSONObject jsonObject= new?JSONObject();
????????if?("status".equals(name)){
????????????jsonObject.put("status",STATUS);
????????}else?if?("detail".equals(name)){
????????????jsonObject.put("detail",DETAIL);
????????}
????????return?jsonObject;
????}
????@WriteOperation//動(dòng)態(tài)修改指標(biāo)
????public?void?test4(@Selector?String?name,@Nullable?String?value){
????????if?(!StringUtils.isEmpty(value)){
????????????if?("status".equals(name)){
????????????????STATUS = value;
????????????}else?if?("detail".equals(name)){
????????????????DETAIL = value;
????????????}
????????}
????}
}1. @Component 注解表示將該類交給 Spring 進(jìn)行管理,或者也可以再定義一個(gè) Configuration 類來加載該 Bean 也可以,當(dāng)然,如果我們需要提供給第三方使用,如果無法保證當(dāng)前包名被掃描,則需要使用 SpringBoot 的自動(dòng)裝配機(jī)制將該類進(jìn)行管理。2. @ReadOperation 方法可以返回 String 或者 JSONObject 或者 Map 集合等。@Selector 注解則表示訪問斷端點(diǎn)的時(shí)候可以直接訪問子節(jié)點(diǎn)。SpringBoot 應(yīng)用,接下來就可以直接通過 http://localhost:8080/actuator/myEndpoint 進(jìn)行訪問了:
test3_1 方法使用了 @Selector 注解,所以我們可以通過這個(gè)方法每一個(gè)指標(biāo)的明細(xì):
@WriteOperation 注解的方法可以用來修改指標(biāo),這個(gè)方法需要用 post 進(jìn)行訪問,訪問的參數(shù)可以直接使用字符串傳參,也可以直接使用 json 進(jìn)行傳參,修改之后再次查看就可以發(fā)現(xiàn)指標(biāo)已經(jīng)被動(dòng)態(tài)修改:
JMX 監(jiān)控
JMX 全稱為 Java Management Extensions,即 Java 管理擴(kuò)展。它提供了對(duì) Java 應(yīng)用程序和 JVM 的監(jiān)控管理。通過JMX 我們可以監(jiān)控服務(wù)器中各種資源的使用情況以及線程,內(nèi)存和 CPU 等使用情況。jdk 下提供的工具 jConsole:

如何手動(dòng)注冊(cè)一個(gè) JMX MBean
定義一個(gè)接口 SystemInfoMBean(注意名字必須要用MBean結(jié)尾):
public?interface?SystemInfoMBean?{
????int?getCpuCore();
????long?getTotalMemory();
????void?shutdown();
}再定義一個(gè)類實(shí)現(xiàn) SystemInfoMBean接口,實(shí)現(xiàn)類的明明方式為接口名去掉MBean:
public?class?SystemInfo?implements?SystemInfoMBean?{
????@Override
????public?int?getCpuCore()?{
????????return?Runtime.getRuntime().availableProcessors();
????}
????@Override
????public?long?getTotalMemory()?{
????????return?Runtime.getRuntime().totalMemory();
????}
????@Override
????public?void?shutdown()?{
????????System.exit(0);
????}
}最后就是需要將該實(shí)現(xiàn)類進(jìn)行注冊(cè):
public?class?JmxRegisterMain?{
????public?static?void?main(String[] args) throws NotCompliantMBeanException, InstanceAlreadyExistsException, MBeanRegistrationException, MalformedObjectNameException, IOException {
????????MBeanServer mBeanServer= ManagementFactory.getPlatformMBeanServer();
????????ObjectName objectName=new?ObjectName("com.lonely.wolf.note.springboot.actuator.jmx:type=SystemInfo");
????????SystemInfo SystemInfo =new?SystemInfo();
????????mBeanServer.registerMBean(SystemInfo,objectName);
????????System.in.read();
????}
}main 方法,再打開 jConsole 就可以看到成功注冊(cè)了一個(gè) MBean:
Spring 當(dāng)中只要我們使用了 @@Endpoint 或者 @JmxEndpoint 注解,就會(huì)自動(dòng)幫我們注冊(cè)一個(gè) MBean,其原理也是利用了自動(dòng)裝配機(jī)制。SpringBoot 自帶的監(jiān)控之外,也有其他第三方開源的強(qiáng)大監(jiān)控系統(tǒng),如 Prometheus,而且 SpringBoot 也將其進(jìn)行了集成,使用 Prometheus 時(shí)只需要引入如下 jar 包即可:<dependency>
????<groupId>io.micrometergroupId>
????<artifactId>micrometer-registry-prometheusartifactId>
dependency>Prometheus 的話需要單獨(dú)安裝,而且一般會(huì)選擇 Prometheus + Grafana 來共同實(shí)現(xiàn)一個(gè)監(jiān)控平臺(tái),在這里就不做過多介紹,如果感興趣的朋友可以自己去了解下這兩種軟件的使用。Spring Boot actuator 的使用,并分別介紹了其中兩種監(jiān)控類型 HTTP 和 JMX,最后通過一個(gè)例子來實(shí)現(xiàn)了自定義的端點(diǎn),同時(shí)也實(shí)現(xiàn)了手動(dòng)注冊(cè)一個(gè) MBean 的方法。-End-
最近有一些小伙伴,讓我?guī)兔φ乙恍?面試題?資料,于是我翻遍了收藏的 5T 資料后,匯總整理出來,可以說是程序員面試必備!所有資料都整理到網(wǎng)盤了,歡迎下載!

面試題】即可獲取評(píng)論
圖片
表情
