Spring Boot 服務監(jiān)控,健康檢查,線程信息,JVM堆信息,指標收集...
來自：掘金（作者：Richard_Yi）
原文鏈接：
https://juejin.im/post/5e2179def265da3e152d2561
去年我們項目做了微服務1.0的架構(gòu)轉(zhuǎn)型，但是服務監(jiān)控這塊卻沒有跟上。這不，最近我就被分配了要將我們核心的微服務應用全部監(jiān)控起來的任務。我們的微服務應用都是SpringBoot 應用，因此就自然而然的想到了借助Spring Boot 的Actuator 模塊。
本篇是我在完成這個工單之后，對Spring Boot Actuator模塊 學習應用的總結(jié)。在本篇文章中，你可以學習到：
1、Spring Boot Actuator 的快速使用入門
2、Spring Boot Actuator 的一些重要的endpoints的介紹
3、如何通過Actuator 模塊實時查看當前應用的線程 dump信息
4、如何通過Actuator 模塊實時查看當前應用的堆信息
5、如何通過Actuator 模塊實時修改當前應用的日志打印等級
6、...
之后我還會介紹：
TODO：SpringBoot 微服務應用集成Prometheus + Grafana實現(xiàn)監(jiān)控告警
一、什么是 Spring Boot Actuator
Spring Boot Actuator 模塊提供了生產(chǎn)級別的功能，比如健康檢查，審計，指標收集，HTTP 跟蹤等，幫助我們監(jiān)控和管理Spring Boot 應用、Bean加載情況、環(huán)境變量、日志信息、線程信息，JVM 堆信息等?。這個模塊是一個采集應用內(nèi)部信息暴露給外部的模塊，上述的功能都可以通過HTTP 和 JMX 訪問。
因為暴露內(nèi)部信息的特性，Actuator 也可以和一些外部的應用監(jiān)控系統(tǒng)整合（Prometheus, Graphite, DataDog, Influx, Wavefront, New Relic等）。這些監(jiān)控系統(tǒng)提供了出色的儀表板，圖形，分析和警報，可幫助你通過一個統(tǒng)一友好的界面，監(jiān)視和管理你的應用程序。
Actuator使用Micrometer與這些外部應用程序監(jiān)視系統(tǒng)集成。這樣一來，只需很少的配置即可輕松集成外部的監(jiān)控系統(tǒng)。
Micrometer 為 Java 平臺上的性能數(shù)據(jù)收集提供了一個通用的 API，應用程序只需要使用 Micrometer 的通用 API 來收集性能指標即可。Micrometer 會負責完成與不同監(jiān)控系統(tǒng)的適配工作。這就使得切換監(jiān)控系統(tǒng)變得很容易。
對比 Slf4j 之于 Java Logger 中的定位。
二、快速開始，創(chuàng)建一個Spring Boot Actuator Demo
我們先創(chuàng)建一個demo應用。
你可以通過Spring Boot CLI 創(chuàng)建：
spring init -d=web,actuator -n=actuator-demo actuator-demo
或者通過Spring Initializr 創(chuàng)建：
對應的maven依賴：
...org.springframework.boot spring-boot-starter-actuator ...
對應的Gradle 依賴：
dependencies {compile("org.springframework.boot:spring-boot-starter-actuator")}
三、Endpoints 介紹
Spring Boot 提供了所謂的 endpoints （下文翻譯為端點）給外部來與應用程序進行訪問和交互。
打比方來說， /health 端點 提供了關(guān)于應用健康情況的一些基礎(chǔ)信息。metrics 端點提供了一些有用的應用程序指標（JVM 內(nèi)存使用、系統(tǒng)CPU使用等）。
這些 Actuator 模塊本來就有的端點我們稱之為原生端點。根據(jù)端點的作用的話，我們大概可以分為三大類：
應用配置類：獲取應用程序中加載的應用配置、環(huán)境變量、自動化配置報告等與Spring Boot應用密切相關(guān)的配置類信息。
度量指標類：獲取應用程序運行過程中用于監(jiān)控的度量指標，比如：內(nèi)存信息、線程池信息、HTTP請求統(tǒng)計等。
操作控制類：提供了對應用的關(guān)閉等操作類功能。
詳細的原生端點介紹，請以官網(wǎng)為準，這里就不贅述徒增篇幅。
需要注意的就是：
1、每一個端點都可以通過配置來單獨禁用或者啟動
2、不同于Actuator 1.x，Actuator 2.x 的大多數(shù)端點默認被禁掉。Actuator 2.x 中的默認端點增加了 /actuator前綴。默認暴露的兩個端點為 /actuator/health和 /actuator/info
四、端點暴露配置
我們可以通過以下配置，來配置通過JMX 和 HTTP 暴露的端點。
| Property | Default |
|---|---|
management.endpoints.jmx.exposure.exclude | |
management.endpoints.jmx.exposure.include | * |
management.endpoints.web.exposure.exclude | |
management.endpoints.web.exposure.include | info,healt |
可以打開所有的監(jiān)控點
management.endpoints.web.exposure.include=*
也可以選擇打開部分，"*" 代表暴露所有的端點，如果指定多個端點，用","分開
management.endpoints.web.exposure.exclude=beans,trace
Actuator 默認所有的監(jiān)控點路徑都在 /actuator/*，當然如果有需要這個路徑也支持定制。
management.endpoints.web.base-path=/minitor
設(shè)置完重啟后，再次訪問地址就會變成 /minitor/*。
現(xiàn)在我們按照如下配置：
# "*" 代表暴露所有的端點 如果指定多個端點，用","分開management.endpoints.web.exposure.include=*# 賦值規(guī)則同上management.endpoints.web.exposure.exclude=
啟動DEMO程序，訪問 http://localhost:8080/actuator，查看暴露出來的端點：
上面這樣顯示是因為chrome 瀏覽器安裝了 JSON-handle 插件，實際上就是返回一大段json
下面，我會著重介紹幾個比較重要的端點。
五、重要端點解析
5.1?/health端點
/health端點會聚合你程序的健康指標，來檢查程序的健康情況。端點公開的應用健康信息取決于：
management.endpoint.health.show-details=always
該屬性可以使用以下值之一進行配置：
| Name | Description |
|---|---|
never | 不展示詳細信息，up或者down的狀態(tài)，默認配置 |
when-authorized | 詳細信息將會展示給通過認證的用戶。授權(quán)的角色可以通過?management.endpoint.health.roles配置 |
always | 對所有用戶暴露詳細信息 |
按照上述配置，配置成 always之后，我們啟動項目，訪問 http://localhost:8080/actuator/health端口，可以看到這樣的信息：
是不是感覺好像健康信息有點少？先別急，那是因為我們創(chuàng)建的是一個最基礎(chǔ)的Demo項目，沒有依賴很多的組件。
/health端點有很多自動配置的健康指示器：如redis、rabbitmq、db等組件。當你的項目有依賴對應組件的時候，這些健康指示器就會被自動裝配，繼而采集對應的信息。如上面的 diskSpace 節(jié)點信息就是 DiskSpaceHealthIndicator 在起作用。
上述截圖取自官方文檔
這是我另一個項目的 /health端點信息。
當如上的組件有一個狀態(tài)異常，應用服務的整體狀態(tài)即為down。我們也可以通過配置禁用某個組件的健康監(jiān)測。
management.health.mongo.enabled:false
或者禁用所有自動配置的健康指示器：
management.health.defaults.enabled:false
?自定義 Health Indicator
當然你也可以自定義一個Health Indicator，只需要實現(xiàn) HealthIndicator 接口或者繼承 AbstractHealthIndicator類。
/*** @author Richard_yyf* @version 1.0 2020/1/16*/@ComponentpublicclassCustomHealthIndicatorextendsAbstractHealthIndicator{@Overrideprotectedvoid doHealthCheck(Health.Builder builder)throwsException{// 使用 builder 來創(chuàng)建健康狀態(tài)信息// 如果你throw 了一個 exception，那么status 就會被置為DOWN，異常信息會被記錄下來builder.up().withDetail("app","這個項目很健康").withDetail("error","Nothing, I'm very good");}}
最終效果：
5.2?/metrics端點
/metrics端點用來返回當前應用的各類重要度量指標，比如：內(nèi)存信息、線程信息、垃圾回收信息、tomcat、數(shù)據(jù)庫連接池等。
{"names":["tomcat.threads.busy","jvm.threads.states","jdbc.connections.active","jvm.gc.memory.promoted","http.server.requests","hikaricp.connections.max","hikaricp.connections.min","jvm.memory.used","jvm.gc.max.data.size","jdbc.connections.max",....]}
不同于1.x，Actuator在這個界面看不到具體的指標信息，只是展示了一個指標列表。為了獲取到某個指標的詳細信息，我們可以請求具體的指標信息，像這樣：
http://localhost:8080/actuator/metrics/{MetricName}
比如我訪問 /actuator/metrics/jvm.memory.max，返回信息如下：
你也可以用query param的方式查看單獨的一塊區(qū)域。比如你可以訪問 /actuator/metrics/jvm.memory.max?tag=id:Metaspace。結(jié)果就是：
5.3?/loggers端點
/loggers 端點暴露了我們程序內(nèi)部配置的所有l(wèi)ogger的信息。我們訪問 /actuator/loggers可以看到，
你也可以通過下述方式訪問單獨一個logger，
http://localhost:8080/actuator/loggers/{name}
比如我現(xiàn)在訪問 root logger， http://localhost:8080/actuator/loggers/root
{"configuredLevel":"INFO","effectiveLevel":"INFO"}
?改變運行時的日志等級
/loggers端點我最想提的就是這個功能，能夠動態(tài)修改你的日志等級。
比如，我們可以通過下述方式來修改 root logger的日志等級。我們只需要發(fā)起一個URL 為 http://localhost:8080/actuator/loggers/root的 POST請求，POST報文如下：
{"configuredLevel":"DEBUG"}
仔細想想，這個功能是不是非常有用。如果在生產(chǎn)環(huán)境中，你想要你的應用輸出一些Debug信息以便于你診斷一些異常情況，你你只需要按照上述方式就可以修改，而不需要重啟應用。
如果想重置成默認值，把value 改成
null
5.4?/info端點
/info端點可以用來展示你程序的信息。我理解過來就是一些程序的基礎(chǔ)信息。并且你可以按照自己的需求在配置文件 application.properties中個性化配置（默認情況下，該端點只會返回一個空的json內(nèi)容。）：
info.app.name=actuator-test-demoinfo.app.encoding=UTF-8info.app.java.source=1.8info.app.java.target=1.8# 在 maven 項目中你可以直接用下列方式引用 maven properties的值
啟動項目，訪問 http://localhost:8080/actuator/info：
{"app":{"encoding":"UTF-8","java":{"source":"1.8.0_131","target":"1.8.0_131"},"name":"actuator-test-demo"}}
5.5?/beans端點
/beans端點會返回Spring 容器中所有bean的別名、類型、是否單例、依賴等信息。
訪問 http://localhost:8080/actuator/beans，返回如下：
5.6?/heapdump?端點
訪問：http://localhost:8080/actuator/heapdump會自動生成一個 Jvm 的堆文件 heapdump。我們可以使用 JDK 自帶的 Jvm 監(jiān)控工具 VisualVM 打開此文件查看內(nèi)存快照。
5.7?/threaddump?端點
這個端點我個人覺得特別有用，方便我們在日常定位問題的時候查看線程的情況。主要展示了線程名、線程ID、線程的狀態(tài)、是否等待鎖資源、線程堆棧等信息。就是可能查看起來不太直觀。訪問 http://localhost:8080/actuator/threaddump返回如下：
5.8?/shutdown端點
這個端點屬于操作控制類端點，可以優(yōu)雅關(guān)閉 Spring Boot 應用。要使用這個功能首先需要在配置文件中開啟：
management.endpoint.shutdown.enabled=true
由于 shutdown 接口默認只支持 POST 請求，我們啟動Demo項目，向 http://localhost:8080/actuator/shutdown發(fā)起 POST請求。返回信息：
{"message":"Shutting down, bye..."}
然后應用程序被關(guān)閉。
由于開放關(guān)閉應用的操作本身是一件非常危險的事，所以真正在線上使用的時候，我們需要對其加入一定的保護機制，比如：定制Actuator的端點路徑、整合Spring Security進行安全校驗等。（不是特別必要的話，這個端點不用開）
六、整合Spring Security 對端點進行安全校驗
由于端點的信息和產(chǎn)生的交互都是非常敏感的，必須防止未經(jīng)授權(quán)的外部訪問。如果您的應用程序中存在Spring Security的依賴，則默認情況下使用基于表單的HTTP身份驗證來保護端點。
如果沒有，只需要增加對應的依賴即可：
org.springframework.boot spring-boot-starter-security
添加之后，我們需要定義安全校驗規(guī)則，來覆蓋Spring Security 的默認配置。
這里我給出了兩個版本的模板配置：
import org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest;import org.springframework.boot.actuate.context.ShutdownEndpoint;import org.springframework.boot.autoconfigure.security.servlet.PathRequest;import org.springframework.context.annotation.Configuration;import org.springframework.security.config.annotation.web.builders.HttpSecurity;import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;/*** @author Richard_yyf*/@ConfigurationpublicclassActuatorSecurityConfigextendsWebSecurityConfigurerAdapter{/** version1:* 1. 限制 '/shutdown'端點的訪問，只允許ACTUATOR_ADMIN訪問* 2. 允許外部訪問其他的端點* 3. 允許外部訪問靜態(tài)資源* 4. 允許外部訪問 '/'* 5. 其他的訪問需要被校驗* version2:* 1. 限制所有端點的訪問，只允許ACTUATOR_ADMIN訪問* 2. 允許外部訪問靜態(tài)資源* 3. 允許外部訪問 '/'* 4. 其他的訪問需要被校驗*/@Overrideprotectedvoid configure(HttpSecurity http)throwsException{// version1// http// .authorizeRequests()// .requestMatchers(EndpointRequest.to(ShutdownEndpoint.class))// .hasRole("ACTUATOR_ADMIN")// .requestMatchers(EndpointRequest.toAnyEndpoint())// .permitAll()// .requestMatchers(PathRequest.toStaticResources().atCommonLocations())// .permitAll()// .antMatchers("/")// .permitAll()// .antMatchers("/**")// .authenticated()// .and()// .httpBasic();// version2http.authorizeRequests().requestMatchers(EndpointRequest.toAnyEndpoint()).hasRole("ACTUATOR_ADMIN").requestMatchers(PathRequest.toStaticResources().atCommonLocations()).permitAll().antMatchers("/").permitAll().antMatchers("/**").authenticated().and().httpBasic();}}
application.properties的相關(guān)配置如下：
# Spring Security Default user name and passwordspring.security.user.name=actuatorspring.security.user.password=actuatorspring.security.user.roles=ACTUATOR_ADMIN
推薦閱讀：
喜歡我可以給我設(shè)為星標哦
好文章，我?在看?
