目錄閑言碎語：背景Actuator介紹Rest方法來查看Actuatorpom.xml引入Actuator依賴配置application.yml運行項目Actuator配合SpringBootSecurity配置application.xml運行項目配置關閉項目API端口配置application.yml命令行執(zhí)行post關閉指令附：Actuator端口信息附：SpringBoot自帶的健康指示器贈言

閑言碎語：

  最近刷抖音，看到了星爺?shù)暮芏嚯娪?，感嘆星爺給后世留下了很多的經(jīng)典作品，我就在想，作為一名程序員，如何留下影響后人的經(jīng)典傳世之作呢，不經(jīng)意間看到了一篇大佬的文章，已經(jīng)近百萬人瀏覽，這就是對后人的一種影響，然后就有了寫這篇博客的沖動，結合最近在學習的SpringCloud，對每一個組件的原理和使用都進行深度的學習和理解，然后將心得寫在博客里，如果有不對的地方還請大佬進行指正，小弟不勝感激

背景

  微服務之后，系統(tǒng)結構拆分隨著業(yè)務發(fā)展越來越微型化，也意味著節(jié)點會呈現(xiàn)幾何數(shù)量級增長。每個一個節(jié)點都是系統(tǒng)組成部分，如何保持如此多節(jié)點的可用性是一件非常有挑戰(zhàn)的工作。
  全方位監(jiān)控變得越來越重要，當我們遇到bug時，總是希望可以看到更多信息，因此一般我們選用的服務開發(fā)框架都需要有方便又強大的監(jiān)控功能支持。
  Spring Boot Actuator便可以幫助我們全方面監(jiān)控應用節(jié)點.
  比如健康檢查、審計、統(tǒng)計、HTTP追蹤等。我們可以通過JMX或者HTTP endpoints來獲得。spring Boot Admin配合下可以進行頁面展示,也和可以與其它外部應用系統(tǒng)系統(tǒng)整合。

Actuator介紹

  Actuator是SpringBoot的一個非常重要的功能，Actuator 為開發(fā)人員提供了SpringBoot運行狀態(tài)信息，通過Actuator可以查看程序的運行狀態(tài)的信息。同時它提供了運行狀態(tài)的監(jiān)控功能，Actuator的監(jiān)控功能可以通過Rest、遠程shell、JMX方式獲得，首先我們介紹Rest方法來查看Actuator的節(jié)點方法，這種是十分簡單的方法。
  Spring Boot Actuator 的關鍵特性是在應用程序里提供眾多的Web節(jié)點，通過這些節(jié)點可以實時地了解應用程序的運行狀況。有了Actuator,你可以知道Bean在Spring應用程序上下文里是如何組裝在一 起的，并且可以獲取環(huán)境屬性的信息和運行時度量信息等。

Rest方法來查看Actuator

pom.xml引入Actuator依賴

首先在pom.xml種引入spring-boot-starter-actuator依賴，代碼如下：

<dependency>
 <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
   <version>2.3.3.RELEASE</version>
</dependency>

配置application.yml

  在application.yml中配置management.port和management.security.enabled，這倆是向外暴露actuator的端口和actuator的非安全驗證方式。
  在這里指定actuator對外暴露的RestApi端口為9091,Spring1.5x默認采用了Actuator安全驗證,為了能夠在瀏覽器上展示效果，不做安全驗證，將其設置為false。

management:
 server:
 port: 9091 # 對外暴露API接口端口為9001
 servlet:
  context-path: /sys
 security:
 enabled: false # 這是為了在瀏覽器上展示效果 所以設置為false
 endpoints:
 web:
  exposure:
  include: "*" # include表示需要暴露的endpoint，配置時使用“,”隔開，你也可以用*讓所有endpoint暴露出來
 endpoint:
  health:
  enabled: true
  show-details: always # health endpoint只展示了簡單的UP和DOWN狀態(tài)。為了獲得健康檢查中所有指標的詳細信息，可以設置其展示詳細信息。
  shutdown:
  enabled: true

  management.endpoint.health.show-details的默認值為never，除了always之外還有when-authorized。
  exclude表示在暴露endpoint時，排除掉哪些，同樣使用“,”隔開，例如
management.endpoints.web.exposure.exclude=info # 排除info

  注意：如果不指定會默認采用程序的啟動端口，這樣做的目的就是將監(jiān)控端口與項目端口進行區(qū)分。
  不配置監(jiān)控端口：localhost:8080/actuator/
  配置監(jiān)控端口：localhost:9091/sys/actuator/
  特別注意：在2.0之后的版本訪問地址必須要加上/actuator/才可以

運行項目

  就可以看到詳細的信息了，以health為例：

請求路徑：http://localhost:9091/sys/actuator/health

{
	status: "UP",
	components: {
		diskSpace: {
		status: "UP",
			details: {
				total: 161062318080,
				free: 103786217472,
				threshold: 10485760,
				exists: true
			}
		},
		ping: {
			status: "UP"
		}
 	}
}

Actuator配合SpringBootSecurity

  actuator可以配合security進行權限控制，從而保護endpint。
  首先在pom.xml中引入SpringBootSecurity依賴：

<dependency>
 <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-security</artifactId>
</dependency>

配置application.xml

  添加:

spring.security.user.name = admin
spring.security.user.password = admin

  這樣在我們訪問localhost:9091/sys/actuator/的時候就會自動跳轉到安全登錄頁面，提示我們輸入用戶名和密碼。

 security:
 user:
  name: admin
  password: admin

運行項目

  我們的請求路徑由http://localhost:9091/sys/actuator/自動變成了http://localhost:9091/sys/login，輸入配置好的用戶名和密碼，就可以看到對應的各種Api端口信息。

配置關閉項目API端口

配置application.yml

  在endpoint后配置shutdown端口為true，默認情況下系統(tǒng)是關閉該端口，防止他人的惡意關閉項目，是出于對系統(tǒng)的一種保護行為。

endpoint:
  health:
  enabled: true
  show-details: always
  shutdown:
  enabled: true

注意：在這里我們利用cmd窗口以命令行的形式來模擬post請求，如果在瀏覽器直接請求的話會報錯，后臺會提示
Request method ‘GET' not supported。也就是說不支持get請求，我們需要用post。

命令行執(zhí)行post關閉指令

  在命令行中輸入:

$ curl -X POST localhost:9091/actuator/shutdown

  然后命令行提示：

{“message”:“Shutting down, bye…”}

  項目就處于關閉狀態(tài)了！

附：Actuator端口信息

附：SpringBoot自帶的健康指示器

總結

到此這篇關于一文搞懂并學會使用SpringBoot的Actuator運行狀態(tài)監(jiān)控組件的文章就介紹到這了,更多相關spring boot 運行狀態(tài)監(jiān)控內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論