1. 前言

Spring Boot 提供了很多開箱即用的starter，其中有一款非常特別的starter——actuator 。它是用來(lái)對(duì)Spring Boot 應(yīng)用進(jìn)行監(jiān)控、指標(biāo)采集、管理，并提供一些很有用的端點(diǎn)（endpoint）來(lái)實(shí)現(xiàn)上述功能。這有助于我們對(duì)Spring Boot 應(yīng)用進(jìn)行監(jiān)視和管理。我們本文將探討Spring Boot 2.x下的actuator的一些知識(shí)點(diǎn)。

2. 集成

像其它starter一樣，通過(guò)非常簡(jiǎn)單的依賴集成即可開箱即用。我們通過(guò)在項(xiàng)目中引入（以maven為例）：

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

3. endpoints

Actuator的核心是端點(diǎn)（endpoint），我們通過(guò)端點(diǎn)來(lái)獲取應(yīng)用的一些監(jiān)控信息或者通過(guò)端點(diǎn)來(lái)改變系統(tǒng)的一些狀態(tài)。Actuator中內(nèi)置了非常多的端點(diǎn)：

3.1 啟用與關(guān)閉

默認(rèn)情況下除了shutdown是關(guān)閉的其它端點(diǎn)都是啟用的。個(gè)別端點(diǎn)的啟用依賴其他組件，比如我們上篇文章介紹的Prometheus。我們可以在Spring Boot 配置文件中通過(guò)配置（id參見(jiàn)上表）management.endpoint.<id>.enabled來(lái)配置端點(diǎn)是否啟用。

另外我們可以通過(guò)management.endpoints.enabled-by-default來(lái)修改全局端口默認(rèn)配置,以下示例啟用info端點(diǎn)并禁用所有其他端點(diǎn)：

# 先設(shè)置所有的端點(diǎn)默認(rèn)為關(guān)閉
management.endpoints.enabled-by-default=false
# 然后開啟info 端點(diǎn)
management.endpoint.info.enabled=true

3.2 開放與封閉

特別需要我們注意的是，以上只是我們開啟的端點(diǎn)功能，并不意味我們把這些端點(diǎn)暴露給應(yīng)用之外的環(huán)境中去。暴露的配置規(guī)則是 management.endpoints.<web|jmx>.exposure.<include|exclude>我們以web為例，通過(guò)以下方式來(lái)暴露web端點(diǎn)：

# * 為暴露所有web端點(diǎn)，如果暴露的是一個(gè)列表請(qǐng)使用端點(diǎn) id 并以逗號(hào)隔開 
management.endpoints.web.exposure.include='*'

同樣的如果我們要排除一些web端點(diǎn)請(qǐng)用 management.endpoints.web.exposure.exclude來(lái)配置。我們可以通過(guò)/actuator來(lái)列舉暴露的端點(diǎn)。當(dāng)然這個(gè)路徑取決于我們對(duì)management.endpoints.web.basePath的配置。

3.3 安全性

對(duì)于生產(chǎn)環(huán)境來(lái)說(shuō)端點(diǎn)都是敏感的。我們當(dāng)然不希望非法的訪問(wèn)端點(diǎn)，特別如/shutdown這種端點(diǎn)。我們可以通過(guò)上面3.1、3.2進(jìn)行關(guān)閉、封閉操作。也可直接配置management.server.port=-1 來(lái)關(guān)閉管理端點(diǎn)?；蛘叽_保在外面的安全框架諸如Spring security的控制之下。即保證 EndpointRequest.toAnyEndpoint()的安全性。

3.4 自定義端點(diǎn)

Spring Boot 2.x 開始，Actuator支持CRUD模型，而不是舊的RW（讀/寫）模型。我們可以按照兩種策略來(lái)自定義：

• @Endpoint 同時(shí)支持JMX和http
• @JmxEndpoint 只支持JMX技術(shù)
• @WebEndpoint 只支持http

通過(guò)在一個(gè)端點(diǎn)類（必須是Spring Bean）上添加上面其中一個(gè)來(lái)表明該類是一個(gè)端點(diǎn)類。

在類的方法使用@ReadOperation，@WriteOperation或@DeleteOperation，這分別會(huì)映射到Http中的 GET、POST、DELETE（對(duì)http來(lái)說(shuō)）。 以下是我們自定義的一個(gè)端點(diǎn)：

@Component
@Endpoint(id = "features")
public class FeaturesEndpoint {

 private Map<String, Feature> features = new ConcurrentHashMap<>();

 @ReadOperation
 public Map<String, Feature> features() {
  return features;
 }

 @ReadOperation
 public Feature feature(@Selector String name) {
  return features.get(name);
 }

 @WriteOperation
 public void configureFeature(@Selector String name, Feature feature) {
  features.put(name, feature);
 }

 @DeleteOperation
 public void deleteFeature(@Selector String name) {
  features.remove(name);
 }

 public static class Feature {
  private Boolean enabled;

  // [...] getters and setters 
 }

}

注意請(qǐng)務(wù)必保證端點(diǎn)的id在該應(yīng)用中唯一。

3.5 端點(diǎn)擴(kuò)展

假設(shè)我們想要確保我們的應(yīng)用程序的生產(chǎn)實(shí)例永遠(yuǎn)不是SNAPSHOT版本。我們決定通過(guò)更改返回此信息的Actuator端點(diǎn)（/info）來(lái)完成此操作。如果我們的應(yīng)用程序恰好是SNAPSHOT。我們將獲得不同的HTTP狀態(tài)代碼。

我們可以使用@EndpointExtension或其更具體的@EndpointWebExtension、@EndpointJmxExtension輕松擴(kuò)展預(yù)定義端點(diǎn)的行為：

@Component
@EndpointWebExtension(endpoint = InfoEndpoint.class)
public class InfoWebEndpointExtension {
 
 private InfoEndpoint delegate;
 
 // standard constructor
 
 @ReadOperation
 public WebEndpointResponse<Map> info() {
  Map<String, Object> info = this.delegate.info();
  Integer status = getStatus(info);
  return new WebEndpointResponse<>(info, status);
 }
 
 private Integer getStatus(Map<String, Object> info) {
  // return 5xx if this is a snapshot
  return 200;
 }
}

3.6 Spring Boot metrics

運(yùn)維應(yīng)用監(jiān)控依賴于對(duì)應(yīng)用度量（metric）指標(biāo)的抽取。Spring Boot 2.x中的Actuator 對(duì)Micrometer的自動(dòng)配置。 甚至我們可以通過(guò)一個(gè)叫MeterRegistry的Spring Bean來(lái)注冊(cè)一個(gè)自定義的metric指標(biāo)。我們可以通過(guò)/actuator/metrics端點(diǎn)獲取所有的metric指標(biāo)。 也可以通過(guò)/actuator/metrics/{metricName} 來(lái)獲取具體度量的元數(shù)據(jù)。

Micrometer 是一個(gè)應(yīng)用度量門面類庫(kù)，類似SLF4。后面我會(huì)專門寫一篇文章來(lái)介紹這個(gè)知識(shí)點(diǎn)。請(qǐng)關(guān)注我的公眾號(hào)：Felordcn 以保證第一時(shí)間獲取相關(guān)的知識(shí)。

4. 總結(jié)

本文我們介紹了Spring Boot 2.x中Actuator 組件。該組件可以幫助我們來(lái)獲取系統(tǒng)的一些元信息和一些監(jiān)控度量指標(biāo)。對(duì)于Spring Boot 應(yīng)用十分重要。該組件是一個(gè)生產(chǎn)級(jí)別的工具，我們不應(yīng)該忽略它。

好了，以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，謝謝大家對(duì)腳本之家的支持。

作者：碼農(nóng)小胖哥

來(lái)源：https://segmentfault.com/a/1190000020361935

最新評(píng)論