服務監控

Spring Boot Actuator是一個用于監控和管理Spring Boot應用的子項目，它提供了一組REST端點和命令行工具， 用于查看應用的運行狀態、性能指標和健康狀況等。Actuator還支持應用度量數據的導出，以及自定義端點和安全控制等功能。通過使用Spring Boot Actuator，開發人員可以更加方便地了解應用的運行狀況，及時發現和解決問題。

概述

隨著微服務架構的普及，Spring Boot 已經成為Java開發人員的首選框架。然而，隨著應用的規模不斷擴大， 如何有效地監控和管理這些應用成為一個重要的問題。Spring Boot Actuator的出現，為開發人員提供了一個解決方案。本文將詳細介紹Spring Boot Actuator的功能、工作原理、使用場景以及應用示例，幫助讀者更好地理解和掌握這一工具。

功能簡介

• 應用度量數據的導出：Actuator 可以將應用的運行數據導出到各種不同的存儲后端，例如 Prometheus、Datadog、New Relic 等。這樣，開發人員可以方便地使用這些數據來監控應用的性能和健康狀況。
• REST 端點：Actuator 提供了一組 REST 端點，用于查看應用的運行狀態、健康狀況、度量數據等信息。開發人員可以通過 HTTP 請求來獲取這些數據，并使用各種工具進行可視化展示。
• 命令行工具：除了 REST 端點之外，Actuator 還提供了一些命令行工具，例如 spring-boot-cli 和 spring-boot-admin。這些工具可以讓開發人員更方便地管理和監控應用。
• 自定義端點：Actuator 支持自定義端點的開發，讓開發人員可以根據自己的需求來暴露自定義的監控數據。這樣可以更靈活地監控和管理應用。
• 安全控制：Actuator 支持對監控端點的安全控制，例如限制訪問權限、身份驗證等。這樣可以保護應用的敏感信息不被泄露。

Spring-Actuator

默認監控服務

http://localhost:8080/actuator

• 依賴

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

• 配置

management:
  endpoints:
    web:
      exposure:
#        [health, info]
        include: "*"

• 自定義監控

監控端點相關注解：

• @Endpoint：定義一個監控端點，同時支持HTTP和JMX兩種方式。
• @WebEndpoint：定義一個監控端點，只支持HTTP方式。
• @JmxEndpoint：定義一個監控端點，只支持JMX方式。
• @ReadOperation：作用在方法上，可用來返回端點展示的信息（通過 Get 方法請求）。
• @WriteOperation：作用在方法上，可用來修改端點展示的信息（通過 Post 方法請求）。
• @DeleteOperation：作用在方法上，可用來刪除對應端點信息（通過 Delete 方法請求）。
• @Selector：作用在參數上，用來定位一個端點的具體指標路由。

自定義一個端點服務：

@Endpoint(id = "custom")
public class CustomEndpoint {
  /**
   * /actuator/custom
   */
  @ReadOperation
  public Map custom() {
    return new HashMap();
  }

  /**
   * /actuator/custom/{name}?value={value}
   */
  @ReadOperation
  public Map name(@Selector String name, @Nullable String value) {
    return new HashMap();
  }
}

Spring-Admin

Spring-Actuator主要實現數據的采集，以及提供REST API以及JMX的訪問渠道，那么數據具體如何友好地顯示出來？這時我們需要對應的UI，其中spring-boot-admin就是這樣一款工具。

http://localhost:8080/applications

• 服務端

<dependency>
        <groupId>de.codecentric</groupId>
        <artifactId>spring-boot-admin-starter-server</artifactId>
    </dependency>

@EnableAdminServer
public class Application{   }

• 客戶端

<dependency>
        <groupId>de.codecentric</groupId>
        <artifactId>spring-boot-admin-starter-client</artifactId>
        <version>2.6.2</version>
    </dependency>

客戶端配置

spring:
  boot:
    admin:
      client:
        url: http://localhost:8080

Prometheus + Grafana

上面說到，Actuator除了采集指標，提供訪問API外，還提供了“應用度量數據的導出”的功能，這樣就能將我們采集到的指標輸出到指定的存儲服務或終端以便進一步分析。其中Prometheus就是這樣一個應用。

• Prometheus 時序數據庫，用于存儲數據，提供并提供查詢，它存儲了計算機系統在各個時間點上的監控數據
• Grafana 儀表盤，提供監控指標可視化界面。
• 依賴

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

• 配置

management:
  endpoints:
    web:
      exposure:
        include: "*"
  metrics:
    export:
      prometheus:
        enabled: true
  prometheus:
    enabled: true

• prometheus配置

scrape_configs:
  - job_name: 'spring-boot-actuator'
    metrics_path: '/actuator/prometheus'
    static_configs:
      - targets: ['localhost:8080'] # 使用你的Spring Boot應用程序的實際主機和端口替換

• 啟動

prometheus.exe --config.file=prometheus.yml

grafana-server.exe

由于篇幅有限，關于Grafana如何集成Prometheus，網上有很多具體實踐，這里不重復贅述...

問題

• 服務端點

由于項目使用spring-boot版本為2.3.7.RELEASE，而spring-boot-admin-starter-server版本設置設置為2.7.x版本時，UI相關配置一直無法加載，通過源碼可以看到

在2.6.x版本中對應spring-boot-admin-server-ui存在META-IN\spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  de.codecentric.boot.admin.server.ui.config.AdminServerUiAutoConfiguration

而在2.7.x版本中，spring.factories刪除了且改為了 META-INF\spring\org.springframework.boot.autoconfigure.AutoConfiguration.imports

de.codecentric.boot.admin.server.ui.config.AdminServerUiAutoConfiguration

因此如果需要使用2.7.x版本的spring-boot-admin，記得把spring-boot升級到2.7.x

• 參數名稱

參數名稱被解析為arg0，導致請求匹配失敗。通過下面的配置保證編譯后的文件通過反射獲取的參數名稱不變

<plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.11.0</version>
          <configuration>
              <debug>false</debug>
              <!-- 防止方法參數名解析為arg0...  -->
              <compilerArgs>
                  <arg>-parameters</arg>
              </compilerArgs>
          </configuration>
      </plugin>

如果使用Idea，你可以在應用啟動后，Actuator功能面板的Mappings中看到服務地址的變化

結束語

服務監控是為了更好的了解服務運行狀況，及時發現服務可能出現的問題，并在出現故障時能夠有效的定位問題產生的原因。更大層面解決系統運行過程中的維護 成本。關于監控相關的應用還有一些，比如SkyWalking、Zipkin、Elastic APM等等。