Spring Boot Actuator監控使用詳解

• 2019 年 11 月 20 日
• 筆記

版權聲明：本文為部落客原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接和本聲明。

本文鏈接：https://blog.csdn.net/wo541075754/article/details/103155214

在企業級應用中，學習了如何進行SpringBoot應用的功能開發，以及如何寫單元測試、集成測試等還是不夠的。在實際的軟體開發中還需要：應用程式的監控和管理。SpringBoot的Actuator模組實現了應用的監控與管理。

Actuator簡介

生產系統中，往往需要對系統實際運行的情況（例如cpu、io、disk、db、業務功能等指標）進行監控運維。在SpringBoot項目中Actuator模組提供了眾多HTTP介面端點（Endpoint），來提供應用程式運行時的內部狀態資訊。

Actuator模組提供了一個監控和管理生產環境的模組，可以使用http、jmx、ssh、telnet等來管理和監控應用。包括應用的審計（Auditing）、健康（health）狀態資訊、數據採集（metrics gathering）統計等監控運維的功能。同時，提供了可以擴展 Actuator端點（Endpoint）自定義監控指標。這些指標都是以JSON介面數據的方式呈現。

Actuator的使用

使用Spring Boot Actuator需要加入如下依賴：

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

actuator並沒有默認集成在自動配置中，而在作為獨立的項目來呈現的。當引入了上面的依賴，默認會引入actuator相關的兩個項目：

<dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-actuator</artifactId>  </dependency>  <dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-actuator-autoconfigure</artifactId>  </dependency>

其中spring-boot-actuator為功能實現，spring-boot-actuator-autoconfigure為自動配置。

需要注意：因SpringBoot Actuator會暴露服務的詳細資訊，為了保障安全性，建議添加安全控制的相關依賴spring-boot-starter-security，這樣在訪問應用監控端點時，都需要輸入驗證資訊。所需依賴如下：

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

關於security的使用我們在此不進行展開，可在application文件中配置相應的訪問密碼：

spring:    security:      user:        name: admin        password: admin

在下面的內容中為了方便，我們暫時不引入security。

經過以上步驟的操作，啟動SpringBoot項目，actuator便自動集成配置了，可通過：http://localhost:8080/actuator 訪問，結果如下：

{      "_links": {          "self": {              "href": "http://localhost:8080/actuator",              "templated": false          },          "health": {              "href": "http://localhost:8080/actuator/health",              "templated": false          },          "health-component": {              "href": "http://localhost:8080/actuator/health/{component}",              "templated": true          },          "health-component-instance": {              "href": "http://localhost:8080/actuator/health/{component}/{instance}",              "templated": true          },          "info": {              "href": "http://localhost:8080/actuator/info",              "templated": false          }      }  }

默認支援的鏈接有：

/actuator  /actuator/health  /health/{component}/{instance}  /health/{component}  /actuator/info

可以在application配置文件中配置開啟更多的監控資訊：

management:    endpoints:      web:        exposure:          include: '*'  #      base-path: /monitor    endpoint:      health:        show-details: always      shutdown:        enabled: true

• management.endpoints.web.exposure.include=』*』，代表開啟全部監控，也可僅配置需要開啟的監控，如： management.endpoints.web.exposure.include=beans,trace。
• management.endpoint.health.show-details=always，health endpoint開啟顯示全部細節。默認情況下/actuator/health是公開的，但不顯示細節。
• management.endpoints.web.base-path=/monitor，啟用指定的url地址訪問根路徑，默認路徑為/actuator/*，開啟則訪問路徑變為/monitor/*。
• management.endpoint.shutdown.enabled=true，啟用介面關閉SpringBoot。

監控資訊如果需要跨越調用，可通過CORS配置來支援，默認處于禁用狀態。設置management.endpoints.web.cors.allowed-origins屬性後開啟。

比如允許來自https://www.choupangxia.com 域的GET和POST調用：

management:    endpoints:      web:        cors:          allowed-origins: https://www.choupangxia.com          allowed-methods: GET,POST

REST介面

Spring Boot Actuator提供了非常豐富的監控介面，可以通過這些介面了解應用程式運行時的內部狀況。Actuator也支援用戶自定義添加端點，可以根據實際應用，定義一些比較關心的指標，在運行期進行監控。

如果使用web應用(Spring MVC, Spring WebFlux, 或者 Jersey)，還可以使用以下介面：

介面詳解

health主要用來檢查應用的運行狀態，這是使用頻次最高的監控點。通常使用此介面顯示應用實例的運行狀態，以及應用不「健康」的原因，比如資料庫連接、磁碟空間不夠等。

默認情況下health的狀態是開放的，訪問：http://localhost:8080/actuator/health 即可看到應用的狀態。

{      "status" : "UP"  }

設置狀態碼順序：setStatusOrder(Status.DOWN,Status.OUT_OF_SERVICE, Status.UP, Status.UNKNOWN)。 過濾掉不能識別的狀態碼。如果無任何狀態碼，整個SpringBoot應用的狀態是UNKNOWN。將所有收集到的狀態碼排序。返回有序狀態碼序列中的第一個狀態碼，作為整個SpringBoot應用的狀態。

Health通過合併幾個健康指數檢查應用的健康情況。SpringBoot Actuator會自動配置以下內容：

可以通過設置 management.health.defaults.enabled屬性來全部禁用。

原生端點

原生端點分為三大類：

• 應用配置類：獲取應用程式中載入的應用配置、環境變數、自動化配置報告等與Spring Boot應用密切相關的配置類資訊。
• 度量指標類：獲取應用程式運行過程中用於監控的度量指標，比如：記憶體資訊、執行緒池資訊、HTTP請求統計等。
• 操作控制類：提供了對應用的關閉等操作類功能。

應用配置類

/conditions：該端點用來獲取應用的自動化配置報告，其中包括所有自動化配置的候選項。同時還列出了每個候選項自動化配置的各個先決條件是否滿足。該端點可以幫助我們方便的找到一些自動化配置為什麼沒有生效的具體原因。

該報告內容將自動化配置內容分為兩部分：positiveMatches中返回的是條件匹配成功的自動化配置和negativeMatches中返回的是條件匹配不成功的自動化配置。

部分程式碼如下：

"contexts": {          "application": {              "positiveMatches": {                  "MsgAutoConfiguration": [                      {                          "condition": "OnClassCondition",                          "message": "@ConditionalOnClass found required class 'com.secbro2.msg.MsgService'"                      }                  ],                  "MsgAutoConfiguration#msgService": [                      {                          "condition": "OnPropertyCondition",                          "message": "@ConditionalOnProperty (msg.enabled=true) matched"                      },                      {                          "condition": "OnBeanCondition",                          "message": "@ConditionalOnMissingBean (types: com.secbro2.msg.MsgService; SearchStrategy: all) did not find any beans"                      }                  ],

/info：就是在配置文件中配置的以info開頭的資訊，如配置為：

info:    app:      name: spring-boot-actuator      version: 1.0.0

返回結果：

{    "app":{      "name":"spring-boot-actuator",      "version":"1.0.0"    }  }

info中配置的參數也可以通過符號*@*包圍的屬性值來自pom.xml文件中的元素節點。如下：

info:      build:          artifact: @project.artifactId@          name: @project.name@          description: @project.description@          ersion: @project.version@

返回結果：

{      "build": {          "artifact": "spring-learn",          "name": "spring-learn",          "description": "Demo project for Spring Boot",          "ersion": "0.0.1-SNAPSHOT"      }  }

/beans：該端點用來獲取應用上下文中創建的所有Bean。

{  	"contexts": {  		"application": {  			"beans": {  				"endpointCachingOperationInvokerAdvisor": {  					"aliases": [],  					"scope": "singleton",  					"type": "org.springframework.boot.actuate.endpoint.invoker.cache.CachingOperationInvokerAdvisor",  					"resource": "class path resource [org/springframework/boot/actuate/autoconfigure/endpoint/EndpointAutoConfiguration.class]",  					"dependencies": ["environment"]  				},  				"defaultServletHandlerMapping": {  					"aliases": [],  					"scope": "singleton",  					"type": "org.springframework.web.servlet.HandlerMapping",  					"resource": "class path resource [org/springframework/boot/autoconfigure/web/servlet/WebMvcAutoConfiguration$EnableWebMvcConfiguration.class]",  					"dependencies": []  				},  			},  			"parentId": null  		}  	}  }

介面展現了bean的別名、類型、是否單例、類的地址、依賴等資訊。

/configprops：該端點用來獲取應用中配置的屬性資訊報告。

{      "spring.transaction-org.springframework.boot.autoconfigure.transaction.TransactionProperties": {          "prefix": "spring.transaction",          "properties": {}      }  }

上面展示了TransactionProperties屬性的配置資訊。

/mappings：該端點用來返回所有SpringMVC的控制器映射關係報告。

{    "handler": "Actuator web endpoint 'beans'",    "predicate": "{GET /actuator/beans, produces [application/vnd.spring-boot.actuator.v2 json || application/json]}",    "details": {      "handlerMethod": {        "className": "org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping.OperationHandler",        "name": "handle",        "descriptor": "(Ljavax/servlet/http/HttpServletRequest;Ljava/util/Map;)Ljava/lang/Object;"      },      "requestMappingConditions": {        "consumes": [],        "headers": [],        "methods": ["GET"],        "params": [],        "patterns": ["/actuator/beans"],        "produces": [{          "mediaType": "application/vnd.spring-boot.actuator.v2 json",          "negated": false        }, {          "mediaType": "application/json",          "negated": false        }]      }    }  }

/env：該端點與/configprops不同，它用來獲取應用所有可用的環境屬性報告。包括：環境變數、JVM屬性、應用的配置配置、命令行中的參數。

度量指標類

應用配置類提供的指標為靜態報告，而度量指標類端點提供的報告內容則是動態變化的，提供了應用程式在運行過程中的一些快照資訊，比如：記憶體使用情況、HTTP請求統計、外部資源指標等。這些端點對於構建微服務架構中的監控系統非常有幫助。

/metrics：該端點用來返回當前應用的各類重要度量指標，比如：記憶體資訊、執行緒資訊、垃圾回收資訊等。

{      "names": [          "jvm.memory.max",          "jvm.threads.states",          "http.server.requests",          "process.files.max",          "jvm.gc.memory.promoted",          "system.load.average.1m",          "jvm.memory.used",          "jvm.gc.max.data.size",          "jvm.gc.pause",          "jvm.memory.committed",          "system.cpu.count",          "logback.events",          "tomcat.global.sent",          "jvm.buffer.memory.used",          "tomcat.sessions.created",          "jvm.threads.daemon",          "system.cpu.usage",          "jvm.gc.memory.allocated",          "tomcat.global.request.max",          "tomcat.global.request",          "tomcat.sessions.expired",          "jvm.threads.live",          "jvm.threads.peak",          "tomcat.global.received",          "process.uptime",          "tomcat.sessions.rejected",          "process.cpu.usage",          "tomcat.threads.config.max",          "jvm.classes.loaded",          "jvm.classes.unloaded",          "tomcat.global.error",          "tomcat.sessions.active.current",          "tomcat.sessions.alive.max",          "jvm.gc.live.data.size",          "tomcat.threads.current",          "process.files.open",          "jvm.buffer.count",          "jvm.buffer.total.capacity",          "tomcat.sessions.active.max",          "tomcat.threads.busy",          "process.start.time"      ]  }

從上面的示例中有這些重要的度量值：

• 系統資訊：包括處理器數量processors、運行時間uptime和instance.uptime、系統平均負載systemload.average。
• mem.*：記憶體概要資訊，包括分配給應用的總記憶體數量以及當前空閑的記憶體數量。這些資訊來自java.lang.Runtime。
• heap.*：堆記憶體使用情況。這些資訊來自java.lang.management.MemoryMXBean介面中getHeapMemoryUsage方法獲取的java.lang.management.MemoryUsage。
• nonheap.*：非堆記憶體使用情況。這些資訊來自java.lang.management.MemoryMXBean介面中getNonHeapMemoryUsage方法獲取的java.lang.management.MemoryUsage。
• threads.*：執行緒使用情況，包括執行緒數、守護執行緒數（daemon）、執行緒峰值（peak）等，這些數據均來自java.lang.management.ThreadMXBean。
• classes.*：應用載入和卸載的類統計。這些數據均來自java.lang.management.ClassLoadingMXBean。
• gc.*：垃圾收集器的詳細資訊，包括垃圾回收次數gc.ps_scavenge.count、垃圾回收消耗時間gc.ps_scavenge.time、標記-清除演算法的次數gc.ps_marksweep.count、標記-清除演算法的消耗時間gc.ps_marksweep.time。這些數據均來自java.lang.management.GarbageCollectorMXBean。
• httpsessions.*：Tomcat容器的會話使用情況。包括最大會話數httpsessions.max和活躍會話數httpsessions.active。該度量指標資訊僅在引入了嵌入式Tomcat作為應用容器的時候才會提供。
• gauge.*：HTTP請求的性能指標之一，它主要用來反映一個絕對數值。比如上面示例中的gauge.response.hello: 5，它表示上一次hello請求的延遲時間為5毫秒。
• counter.*：HTTP請求的性能指標之一，它主要作為計數器來使用，記錄了增加量和減少量。如上示例中counter.status.200.hello: 11，它代表了hello請求返回200狀態的次數為11。

/threaddump：會生成當前執行緒活動的快照。方便我們在日常定位問題的時候查看執行緒的情況。主要展示了執行緒名、執行緒ID、執行緒的狀態、是否等待鎖資源等資訊。

{  	"threads": [{  		"threadName": "Reference Handler",  		"threadId": 2,  		"blockedTime": -1,  		"blockedCount": 2,  		"waitedTime": -1,  		"waitedCount": 0,  		"lockName": null,  		"lockOwnerId": -1,  		"lockOwnerName": null,  		"daemon": true,  		"inNative": false,  		"suspended": false,  		"threadState": "RUNNABLE",  		"priority": 10,  		"stackTrace": [{  			"classLoaderName": null,  			"moduleName": "java.base",  			"moduleVersion": "11.0.4",  			"methodName": "waitForReferencePendingList",  			"fileName": "Reference.java",  			"lineNumber": -2,  			"className": "java.lang.ref.Reference",  			"nativeMethod": true  		}    ...    "lockedMonitors": [],  		"lockedSynchronizers": [{  			"className": "java.util.concurrent.locks.ReentrantLock$NonfairSync",  			"identityHashCode": 2060076420  		}],  		"lockInfo": null    ...    {  		"threadName": "DestroyJavaVM",  		"threadId": 42,  		"blockedTime": -1,  		"blockedCount": 0,  		"waitedTime": -1,  		"waitedCount": 0,  		"lockName": null,  		"lockOwnerId": -1,  		"lockOwnerName": null,  		"daemon": false,  		"inNative": false,  		"suspended": false,  		"threadState": "RUNNABLE",  		"priority": 5,  		"stackTrace": [],  		"lockedMonitors": [],  		"lockedSynchronizers": [],  		"lockInfo": null  	}]  }

/trace：該端點用來返回基本的HTTP跟蹤資訊。默認情況下，跟蹤資訊的存儲採用。

操作控制類

/shutdown：配置文件中配置開啟此功能：

management.endpoint.shutdown.enabled=true

使用 curl 模擬 post 請求此介面：

curl -X POST "http://localhost:8080/actuator/shutdown"

顯示結果為：

{      "message": "Shutting down, bye..."  }

小結

本篇文章介紹了SpringBoot Actuator監控的基本功能和詳解，下篇文章將會帶大家了解一下該功能在Spring Boot中的實現原理。歡迎關注公眾號「程式新視界」。

原文鏈接：《Spring Boot Actuator監控使用詳解》