您好,登錄后才能下訂單哦!
這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)碛嘘P(guān)SpringBoot服務(wù)監(jiān)控機(jī)制的原理是什么,文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述,閱讀完這篇文章希望大家可以有所收獲。
SpringBoot
中的監(jiān)控可以分為 HTTP
端點(diǎn)和 JMX
兩種方式來監(jiān)控當(dāng)前應(yīng)用的運(yùn)行狀況和指標(biāo)收集
執(zhí)行器端點(diǎn)允許您監(jiān)視應(yīng)用程序并與之交互。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
作為基本路,訪問地址則對應(yīng)為 :http:ip:port/actuator/{id}
。
使用 HTTP
監(jiān)控非常簡單,在 SpringBoot
項(xiàng)目中,引入如下依賴:
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> </dependencies>
默認(rèn)就可以通過地址 http:localhost:8080/actuator/health
,訪問之后得到如下結(jié)果:
SpringBoot
中提供了非常多的默認(rèn)端點(diǎn)監(jiān)控,但是出于安全考慮,默認(rèn)情況下有些端點(diǎn)并不是開啟狀態(tài),如 shutdown
端點(diǎn)就是默認(rèn)關(guān)閉的。
內(nèi)置端點(diǎn)
SpringBoot
中默認(rèn)提供的常用內(nèi)置端點(diǎn)如下:
端點(diǎn) id | 描述 |
---|---|
auditevents | 公開當(dāng)前應(yīng)用程序的審計(jì)事件信息,需要 AuditEventRepository Bean。 |
beans | 展示程序中所有的 Bean。 |
caches | 公開可用的緩存。 |
conditions | 展示配置類或者自動(dòng)裝配類中的條件,以及它們匹配或者不匹配的原因。 |
configprops | 顯示所有 @ConfigurationProperties 中的配置屬性。 |
env | 顯示 ConfigurableEnvironment 中的所有環(huán)境。 |
health | 顯示應(yīng)用程序運(yùn)行狀況信息。 |
httptrace | 顯示 HTTP 跟蹤信息(默認(rèn)情況下統(tǒng)計(jì)最近 100 次請求),需要 HttpTraceRepository Bean。 |
info | 顯示任意程序信息。 |
integrationgraph | 顯示 Spring 集成圖,需要依賴 spring-integration-core。 |
loggers | 展示和修改應(yīng)用中的 loggers 配置。 |
metrics | 展示當(dāng)前應(yīng)用監(jiān)控指標(biāo)的度量。 |
mappings | 展示所有 @RequestMapping 路徑。 |
scheduledtasks | 展示應(yīng)用中的所有定時(shí)任務(wù)信息。 |
sessions | 允許從 Spring 會(huì)話支持的會(huì)話存儲中檢索和刪除用戶會(huì)話。需要使用基于 Spring Session web應(yīng)用程序。 |
shutdown | 優(yōu)雅的關(guān)閉程序,默認(rèn)禁止了該端點(diǎn)的訪問。 |
雖然說這里的大部分端點(diǎn)都是默認(rèn)開啟的,但是默認(rèn)暴露(允許對外訪問)的只有 health
和 info
端點(diǎn),所以如果需要允許端點(diǎn)對外暴露,可以通過如下配置(如果想要暴露所有的端點(diǎn),則可以直接配置 "*"
):
management: endpoints: web: exposure: include: [health,info,mappings] //或者直接配置 "*"
另外,開啟或禁用某一個(gè)端點(diǎn),也可以通過通過如下配置進(jìn)行動(dòng)態(tài)控制:
management.endpoint.<id>.enabled=true
接下來我們挑選幾個(gè)重點(diǎn)的端點(diǎn)來介紹一下。
health 端點(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: always
這個(gè)配置打開之后,我們連接上 Redis
之后再次訪問 health
端點(diǎn),就可以展示 Redis
服務(wù)的健康信息了:
loggers 端點(diǎn)
訪問 http://localhost:8080/actuator/loggers
可以查看當(dāng)前應(yīng)用的日志級別等信息:
這里面本身并不特別,但是有一個(gè)功能卻非常有用,比如我們生產(chǎn)環(huán)境日志級別一般都是 info
,但是現(xiàn)在有一個(gè) bug
通過 info
級別無法排查,那么我們就可以臨時(shí)修改 log
級別。
比如上圖中的 ROOT
節(jié)點(diǎn)是 info
級別,那么我們可以通過 postman
等工具來發(fā)一個(gè) post
請求修改日志級別。
修改之后就會(huì)發(fā)現(xiàn),日志由原來的 info
變成了 debug
:
metrics 端點(diǎn)
metrics
是一個(gè)非常重要的監(jiān)控端點(diǎn),其監(jiān)控內(nèi)容覆蓋了 JVM
內(nèi)存、堆、類加載、處理器和 tomcat
容器等一些重要指標(biāo):
可以看到這里面包含了非常多的指標(biāo),任意訪問一個(gè)指標(biāo)就可以查看對應(yīng)的指標(biāo)信息:
自定義監(jiān)控端點(diǎn)
通過上面的介紹,可以看到 SpringBoot
提供的監(jiān)控非常強(qiáng)大,但是就算再全面的監(jiān)控也不可能滿足所有人的需求,所以 SpringBoot
也支持自定義監(jiān)控端點(diǎn)。
自定義監(jiān)控端點(diǎn)常用注解
自定義一個(gè)監(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
方式。
以上三個(gè)注解作用在類上,表示當(dāng)前類是一個(gè)監(jiān)控端點(diǎn),另外還有一些注解會(huì)用在方法和參數(shù)上:
@ReadOperation:作用在方法上,可用來返回端點(diǎn)展示的信息(通過 Get
方法請求)。
@WriteOperation:作用在方法上,可用來修改端點(diǎn)展示的信息(通過 Post
方法請求)。
@DeleteOperation:作用在方法上,可用來刪除對應(yīng)端點(diǎn)信息(通過 Delete
方法請求)。
@Selector:作用在參數(shù)上,用來定位一個(gè)端點(diǎn)的具體指標(biāo)路由。
來,一起寫一個(gè)自己的監(jiān)控端點(diǎn)
定義一個(gè)類,并使用 @Endpoint
注解標(biāo)注標(biāo)識,同時(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<String,String> test2(){ // Map<String,String> 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; } } } }
@Component
注解表示將該類交給 Spring
進(jìn)行管理,或者也可以再定義一個(gè) Configuration
類來加載該 Bean
也可以,當(dāng)然,如果我們需要提供給第三方使用,如果無法保證當(dāng)前包名被掃描,則需要使用 SpringBoot
的自動(dòng)裝配機(jī)制將該類進(jìn)行管理。
@ReadOperation
方法可以返回 String
或者 JSONObject
或者 Map
集合等。參數(shù)上加了 @Selector
注解則表示訪問斷端點(diǎn)的時(shí)候可以直接訪問子節(jié)點(diǎn)。
完成了上面的類,啟動(dòng) SpringBoot
應(yīng)用,接下來就可以直接通過 http://localhost:8080/actuator/myEndpoint
進(jìn)行訪問了:
同時(shí),因?yà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
全稱為 Java Management Extensions,即 Java
管理擴(kuò)展。它提供了對 Java
應(yīng)用程序和 JVM
的監(jiān)控管理。通過JMX
我們可以監(jiān)控服務(wù)器中各種資源的使用情況以及線程,內(nèi)存和 CPU
等使用情況。
打開 jdk
下提供的工具 jConsole
:
打開之后這里會(huì)監(jiān)控到我們已經(jīng)啟動(dòng)的應(yīng)用,雙擊進(jìn)入:
如何手動(dòng)注冊一個(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)行注冊:
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();//防止程序結(jié)束 } }
運(yùn)行該 main
方法,再打開 jConsole
就可以看到成功注冊了一個(gè) MBean
:
同樣的,Spring
當(dāng)中只要我們使用了 @@Endpoint
或者 @JmxEndpoint
注解,就會(huì)自動(dòng)幫我們注冊一個(gè) MBean
,其原理也是利用了自動(dòng)裝配機(jī)制。
除了 SpringBoot
自帶的監(jiān)控之外,也有其他第三方開源的強(qiáng)大監(jiān)控系統(tǒng),如 Prometheus
,而且 SpringBoot
也將其進(jìn)行了集成,使用 Prometheus
時(shí)只需要引入如下 jar
包即可:
<dependency> <groupId>io.micrometer</groupId> <artifactId>micrometer-registry-prometheus</artifactId> </dependency>
上述就是小編為大家分享的SpringBoot服務(wù)監(jiān)控機(jī)制的原理是什么了,如果剛好有類似的疑惑,不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識,歡迎關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。