Java EE（ SSM + Spring Boot + Vue.js 3 ）框架整合開發(fā) 課件 第13章 監(jiān)控Spring Boot應(yīng)用

第十三章監(jiān)控SpringBoot應(yīng)用授課教師：陳恒大連外國語大學(xué)本章目標了解Actuator的管理功能掌握如何通過HTTP進行SpringBoot的應(yīng)用監(jiān)控和管理功能掌握如何自定義端點和HealthIndicator實現(xiàn)1本章內(nèi)容213.1端點的分類與測試13.2自定義端點13.3自定義HealthIndicator13.1端點的分類與測試13.1.1端點的開啟與暴露13.1.2應(yīng)用配置端點的測試13.1.3度量指標端點的測試13.1.4操作控制端點的測試313.1.1端點的開啟與暴露SpringBoot提供了許多監(jiān)控和管理功能的端點。根據(jù)端點的作用，可以將SpringBoot提供的原生端點分為三大類：應(yīng)用配置端點、度量指標端點和操作控制端點。【例13-1】查看SpringBoot默認暴露的端點。4【例13-1】1．創(chuàng)建基于SpringBootActuator依賴的Web應(yīng)用ch13_1創(chuàng)建基于SpringBootActuator依賴的Web應(yīng)用ch13_1。2．配置JSON輸出格式在Web應(yīng)用ch13_1的配置文件perties中，配置JSON字符串的輸出格式，具體如下：#輸出的JSON字符串格式更美觀spring.jackson.serialization.indent-output=true56【例13-1】3．啟動主程序查看默認暴露的端點啟動Web應(yīng)用ch13_1的主程序Ch131Application后，通過訪問“http://localhost:8080/actuator”查看默認暴露的端點，運行效果如下圖所示。從上圖可以看出SpringBoot默認暴露了health和info兩個端點。如果想暴露SpringBoot提供的所有端點，需要在配置文件perties配置“management.endpoints.web.exposure.include=*”，配置后重啟應(yīng)用主程序，重新訪問“http://localhost:8080/actuator”即可查看所有暴露的端點。端點暴露設(shè)置7默認情況下，除了shutdown端點是關(guān)閉的，其它端點都是開啟的。配置一個端點的開啟，使用management.endpoint..enabled屬性，如啟用shutdown端點：

management.endpoint.shutdown.enabled=true我們在配置文件中可使用“management.endpoints.web.exposure.include”屬性列出暴露的端點，示例如下：management.endpoints.web.exposure.include=info,health,env,beans“*”可用來表示所有的端點，例如，除了env和beans端點，通過HTTP暴露所有端點，示例如下：

management.endpoints.web.exposure.include=*management.endpoints.web.exposure.exclude=env,beans13.1端點的分類與測試13.1.1端點的開啟與暴露13.1.2應(yīng)用配置端點的測試13.1.3度量指標端點的測試13.1.4操作控制端點的測試813.1.2應(yīng)用配置端點的測試通過應(yīng)用配置端點就可以幫助我們輕松的獲取一系列關(guān)于Spring應(yīng)用配置內(nèi)容的詳細報告，比如：自動化配置的報告、Bean創(chuàng)建的報告、環(huán)境屬性的報告等。91．conditions該端點在1.x版本中名為autoconfig，該端點用來獲取應(yīng)用的自動化配置報告，其中包括所有自動化配置的候選項。同時還列出了每個候選項自動化配置的各個先決條件是否滿足。所以，該端點可以幫助我們方便的找到一些自動化配置為什么沒有生效的具體原因。該報告內(nèi)容將自動化配置內(nèi)容分為三部分：positiveMatches中返回的是條件匹配成功的自動化配置；negativeMatches中返回的是條件匹配不成功的自動化配置；unconditionalClasses無條件配置類。啟動并暴露該端點后，可通過“http://localhost:8080/actuator/conditions”測試訪問。102．beans該端點用來獲取應(yīng)用上下文中創(chuàng)建的所有Bean，啟動并暴露該端點后，可通過“http://localhost:8080/actuator/beans”測試訪問。每個Bean中都包含以下幾個信息：外層的key是Bean的名稱；aliases是Bean的別名；scope是Bean的作用域；type是Bean的Java類型；resource是class文件的具體路徑；dependencies是依賴的Bean名稱。113．configprops該端點用來獲取應(yīng)用中配置的屬性信息報告，prefix屬性代表了屬性的配置前綴，properties代表了各個屬性的名稱和值，例如可以設(shè)置spring.http.encoding.charset="UTF-8"。啟動并暴露該端點后，可通過“http://localhost:8080/actuator/configprops”測試訪問。124．env該端點與configprops端點不同，它用來獲取應(yīng)用所有可用的環(huán)境屬性報告。包括：環(huán)境變量、JVM屬性、應(yīng)用的配置、命令行中的參數(shù)等內(nèi)容。啟動并暴露該端點后，可通過“http://localhost:8080/actuator/env”測試訪問。135．mappings該端點用來返回所有SpringMVC的控制器映射關(guān)系報告。啟動并暴露該端點后，可通過“http://localhost:8080/actuator/mappings”測試訪問。146．info該端點用來返回一些應(yīng)用自定義的信息。默認情況下，該端點只會返回一個空的json內(nèi)容。我們可以在perties配置文件中通過info前綴來設(shè)置一些屬性。比如：=spring-boot-helloinfo.app.version=v1.0.0啟動并暴露該端點后，可通過“http://localhost:8080/actuator/info”測試訪問。1513.1端點的分類與測試13.1.1端點的開啟與暴露13.1.2應(yīng)用配置端點的測試13.1.3度量指標端點的測試13.1.4操作控制端點的測試1613.1.3度量指標端點的測試通過度量指標端點可獲取應(yīng)用程序運行過程中用于監(jiān)控的度量指標，比如：內(nèi)存信息、線程信息、HTTP請求統(tǒng)計等。171．metrics該端點用來返回當前應(yīng)用的各類重要度量指標，比如：內(nèi)存信息、線程信息、垃圾回收信息等。啟動并暴露該端點后，可通過“http://localhost:8080/actuator/metrics”測試訪問。metrics端點可以提供應(yīng)用運行狀態(tài)的完整度量指標報告，這項功能非常的實用，但是對于監(jiān)控系統(tǒng)中的各項監(jiān)控功能，它們的監(jiān)控內(nèi)容、數(shù)據(jù)收集頻率都有所不同，如果我們每次都通過全量獲取報告的方式來收集，略顯粗暴。所以，我們還可以通過/metrics/{name}接口來更細粒度的獲取度量信息，比如我們可以通過訪問/metrics/jvm.memory.used來獲取當前JVM使用的內(nèi)存數(shù)量。182．health該端點用來獲取應(yīng)用的各類健康指標信息。在spring-boot-starter-actuator模塊中自帶實現(xiàn)了一些常用資源的健康指標檢測器。啟動并暴露該端點后，可通過“http://localhost:8080/actuator/health”測試訪問。結(jié)果中的“UP”表示健康，“DOWN”表示異常?？梢栽谂渲梦募校渲脤傩詍anagement.endpoint.health.show-details=always，將詳細健康信息顯示給所有用戶。再次啟動應(yīng)用后，刷新http://localhost:8080/actuator/health，顯示健康指標詳細信息。193．threaddump該端點用來暴露程序運行中的線程信息。它使用java.lang.management.ThreadMXBean的dumpAllThreads方法來返回所有含有同步信息的活動線程詳情。啟動并暴露該端點后，可通過“http://localhost:8080/actuator/threaddump”測試訪問。204．scheduledtasks該端點統(tǒng)計應(yīng)用程序中調(diào)度的任務(wù)。啟動并暴露該端點后，可通過“http://localhost:8080/actuator/scheduledtasks”測試訪問。2113.1端點的分類與測試13.1.1端點的開啟與暴露13.1.2應(yīng)用配置端點的測試13.1.3度量指標端點的測試13.1.4操作控制端點的測試2213.1.4操作控制端點的測試操作控制類端點擁有更強大的控制能力，如果使用它們，需要通過屬性來配置開啟。在原生端點中，只提供了一個用來關(guān)閉應(yīng)用的端點：shutdown。可以通過如下配置開啟它：management.endpoint.shutdown.enabled=true。23shutdown端點不支持get提交，不可以直接在瀏覽器上訪問，所以我們這里可以使用GoogleChrome的PostmanRESTClient測試。用post方式訪問“http://localhost:8080/actuator/shutdown”，測試效果如下圖所示。本章內(nèi)容2413.1端點的分類與測試13.2自定義端點13.3自定義HealthIndicator13.2自定義端點SpringBoot提供了注解@Endpoint供我們定義一個端點類，并在端點類的方法上使用@ReadOperation注解來顯示監(jiān)控信息（對應(yīng)Get請求），使用@WriteOperation來動態(tài)更新監(jiān)控信息（對應(yīng)Post請求）。【例13-2】自定義端點。25【例13-2】261．創(chuàng)建基于SpringDataJPA和SpringBootActuator依賴的Web應(yīng)用ch13_2創(chuàng)建基于SpringDataJPA和SpringBootActuator依賴的Web應(yīng)用ch13_2。2．修改pom.xml文件添加MySQL連接器依賴修改pom.xml文件添加MySQL連接器依賴。3．配置數(shù)據(jù)源因為該實例是監(jiān)控數(shù)據(jù)源信息，所以需要在配置文件perties中配置數(shù)據(jù)源，具體內(nèi)容如下：#數(shù)據(jù)庫地址spring.datasource.url=jdbc:mysql://localhost:3306/springbootjpa?characterEncoding=utf8#數(shù)據(jù)庫用戶名spring.datasource.username=root#數(shù)據(jù)庫密碼spring.datasource.password=root#數(shù)據(jù)庫驅(qū)動spring.datasource.driver-class-name=com.mysql.jdbc.Driver#輸出的JSON字符串格式更美觀spring.jackson.serialization.indent-output=true【例13-2】274．自定義端點創(chuàng)建名為com.ch.ch13_2.endPoint的包，并在該包中使用注解@Endpoint自定義端點類DataSourceEndpoint。在該端點類中，使用@ReadOperation注解來顯示數(shù)據(jù)源信息，使用@WriteOperation來動態(tài)更新數(shù)據(jù)源信息。5．暴露端點在配置文件perties中暴露端點，內(nèi)容如下：#暴露所有端點，當然包括data-source，我們也可以只暴露data-source端點management.endpoints.web.exposure.include=*6．測試端點28首先，啟動應(yīng)用程序主類Ch132Application，然后通過“http://localhost:8080/actuator/data-source”測試端點data-source，運行效果如左下圖所示。使用GoogleChrome的PostmanRESTClient發(fā)送POST請求“http://localhost:8080/actuator/data-source?max=20”，POST請求執(zhí)行后，“http://localhost:8080/actuator/data-source”測試端點data-source，運行效果如右上圖所示。本章內(nèi)容2913.1端點的分類與測試13.2自定義端點13.3自定義HealthIndicator13.3自定義HealthIndicator當SpringBoot自帶的HealthIndicator接口實現(xiàn)類不能滿足我們的需求時，就需要自定義HealthIndicator接口實現(xiàn)類。自定義HealthIndicator接口實現(xiàn)類很簡單，只需要實現(xiàn)HealthIndicator接口，并重寫接口方法health，返回一個Health對象?！纠?3-3】自定義HealthIndicator。301．創(chuàng)建HealthIndicator接口實現(xiàn)類MyHealthIndicator31@ComponentpublicclassMyHealthIndicatorimplementsHealthIndicator{ @Override

publicHealthhealth(){ interrorCode=check(); if(errorCode!=0){ //down方法表示異常，withDetail方法添加任意多的異常信息 returnHealth.down().withDetail("message","error:"+errorCode).build(); } //up方法表