Application Real-Time Monitoring Service：Spring Boot應用如何快速接入Prometheus監控

接入流程概述

針對Spring Boot應用，社區提供了開箱即用的Spring Boot Actuator架構，方便Java開發人員進行代碼埋點和監測資料收集、輸出。從Spring Boot 2.0開始，Actuator將底層改為Micrometer，同時提供了更強、更靈活的監測能力。Micrometer是一個監測門面，可以類比成監測界的Slf4j ，藉助Micrometer，應用則能夠對接各種監測系統。例如，AppOptics、Datadog、Elastic、InfluxDB以及可觀測監控 Prometheus 版等。

Micrometer在將可觀測監控 Prometheus 版指標對接到Java應用的指標時，支援應用開發人員用三個類型的語義來映射：

• Micrometer中的Counter指標類型對應於可觀測監控 Prometheus 版中的Counter指標類型，用來描述一個單調遞增的變數。如某個介面的訪問次數、快取命中或者訪問總次數等。Timer在邏輯上蘊含了Counter，即如果使用Timer採集每個介面的回應時間，必然也會採集訪問次數。因此無需為某個介面同時指定Timer與Counter兩個指標。

• MicroMeter中的Gauge指標類型對應於可觀測監控 Prometheus 版中的Gauge指標類型，用來描述在一個範圍內持續波動的變數。如CPU使用率、線程池任務隊列數等。

• MicroMeter中的Timer指標類型對應於可觀測監控 Prometheus 版中的Histogram，用來描述與時間相關的資料。如某個介面RT時間分布等。

• Micrometer中的DistributionSummary指標類型對應可觀測監控 Prometheus 版中的Summary指標類型 ，與Histogram類似，Summary也是用於統計資料分布的，但由於資料的分布情況是在用戶端計算完成後再傳入可觀測監控 Prometheus 版進行儲存，因此Summary的結果無法在多個機器之間進行資料彙總，無法統計全域視圖的資料分布，使用起來有一定局限性。

接入流程

當您需要把部署在Kubernetes叢集中的Spring Boot應用接入到可觀測監控 Prometheus 版時，需要按照代碼埋點>部署應用>服務發現這個流程來進行。

首先，您需要在代碼中引入Spring Boot Actuator相關Maven依賴，並對您需要監測的資料進行註冊，或對Controller內的方法打上相應的註解。

其次，您需要將埋點後的應用部署在Kubernetes中，並向可觀測監控 Prometheus 版註冊嚮應用拉取監測資料的端點（即可觀測監控 Prometheus 版的服務發現）。阿里雲Prometheus服務提供了使用ServiceMonitor CRD進行服務發現的方法。

最後，在目標應用的監測採集端點被可觀測監控 Prometheus 版成功發現後，您就可以在Grafana上配置資料來源及相應的大盤。同時您也可以根據某些關鍵計量進行對應的警示配置。

最終目標

通過將部署在Kubernetes叢集中的Spring Boot應用接入到可觀測監控 Prometheus 版，希望能夠實現以下幾點目標：

• 監測系統的入口：Frontend服務是一個基於SpringMVC開發的入口應用，承接外部的客戶流量，這裡主要關注的是外部介面的關鍵RED指標。例如，調用率Rate、失敗數Error、請求耗時Duration。

• 監測系統的關鍵鏈路：對後端服務critical path上的對象進行監測。例如，線程池的隊列情況、進程內Guava Cache緩衝的命中情況。

• 實現對業務強相關的自訂指標進行監測。例如，某個介面的UV等。

• 實現對JVM GC及記憶體使用量情況進行監測。

• 實現對上述指標進行統一匯聚展示，以及配置關鍵計量的警示。

步驟一：引入Spring Boot Actuator依賴，進行初始配置

這裡選取一個基於Spring Boot和Spring Cloud Alibaba構建的雲原生微服務應用，為您介紹部署在Kubernetes叢集上的Spring Boot微服務應用如何進行Prometheus接入的具體接入流程。

1. 執行如下程式碼片段，引入Spring Boot Actuator的相關依賴。

   <!-- spring-boot-actuator依賴 -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-actuator</artifactId>
   </dependency>
   <!-- prometheus依賴 -->
   <dependency>
       <groupId>io.micrometer</groupId>
       <artifactId>micrometer-registry-prometheus</artifactId>
   </dependency>

2. 在application.properties中添加相關配置暴露監測資料連接埠。例如，連接埠為8091。

   # application.properties添加以下配置用於暴露指標
   spring.application.name=frontend
   
   management.server.port=8091
   management.endpoints.web.exposure.include=*
   management.metrics.tags.application=${spring.application.name}

   配置成功後，即可訪問該應用的8091連接埠，然後您可以在該連接埠的/actuator/prometheus路徑中擷取OpenMetrics標準的監測資料。

步驟二：代碼埋點及改造

若要擷取某個API介面的RED指標，您需要在對應的介面方法上打@Timed註解。這裡以index頁面介面為例打@Timed註解，如下程式碼片段所示。

@Timed(value = "main_page_request_duration", description = "Time taken to return main page", histogram = true)
@ApiOperation(value = "首頁", tags = {"首頁操作頁面"})
@GetMapping("/")
public String index(Model model) {
    model.addAttribute("products", productDAO.getProductList());

    model.addAttribute("FRONTEND_APP_NAME", Application.APP_NAME);
    model.addAttribute("FRONTEND_SERVICE_TAG", Application.SERVICE_TAG);
    model.addAttribute("FRONTEND_IP", registration.getHost());

    model.addAttribute("PRODUCT_APP_NAME", PRODUCT_APP_NAME);
    model.addAttribute("PRODUCT_SERVICE_TAG", PRODUCT_SERVICE_TAG);
    model.addAttribute("PRODUCT_IP", PRODUCT_IP);

    model.addAttribute("new_version", StringUtils.isBlank(env));
    return "index.html";
}

若您的應用中使用了進程內緩衝庫（例如，最常見的Guava Cache庫等）且需要追蹤進程內緩衝的健全狀態，您可以按照Micrometer提供的修飾方法，對於待監測的關鍵對象進行封裝。

Guava Cache改造

1. 注入MeterRegistry，這裡注入的具體實現是PrometheusMeterRegistry，由Spring Boot自行注入即可。

2. 使用工具類API封裝本機快取，即如下圖中的GuavaCacheMetrics.monitor。

3. 開啟快取資料記錄，即調用.recordStats()方法。

4. 為Cache對象命名，用於產生對應的指標。

線程池改造

1. 注入MeterRegistry，這裡注入的具體實現是PrometheusMeterRegistry。

2. 使用工具類API封裝線程池。

3. 為線程池命名，用於產生對應的指標。

在開發過程中還會涉及許多業務強相關的自訂指標，為了監測這些指標，在往Bean中注入MeterRegistry後，您還需要按照需求和對應情境構造Counter、Gauge或Timer來進行資料統計，並將其註冊到MeterRegistry進行指標暴露，樣本如下。

@Service
public class DemoService {

    Counter visitCounter;

    public DemoService(MeterRegistry registry) {
        visitCounter = Counter.builder("visit_counter")
            .description("Number of visits to the site")
            .register(registry);
    }

    public String visit() {
        visitCounter.increment();
        return "Hello World!";
    }    
}

至此，您對應用的代碼改造工作已全部完成。然後您需要將應用鏡像重新構建並部署到已安裝可觀測監控 Prometheus 版的Kubernetes叢集中，並在可觀測監控 Prometheus 版控制台中配置ServiceMonitor，進行服務發現。更多資訊，請參見Prometheus執行個體 for Container Service和管理Kubernetes叢集服務發現。

ServiceMonitor配置完成後，您可以在Targets列表中查看到剛註冊的Service應用。

步驟三：看板配置

應用的監測資料已成功收集並儲存到可觀測監控 Prometheus 版，因此您可以配置相應的大盤及警示來查看監控到的資料。這裡，為您提供以下兩個Grafana社區中的開源大盤模板來構建您自己的業務監測模板。

• Spring Boot 2.1 Statistics

• JVM (Micrometer)

藉助以上模板以及可觀測監控 Prometheus 版內建的Grafana服務，您可以根據自己的需求，將日常開發和營運過程中需要重點關注的指標展示在同一個Grafana Dashboard頁面上，建立屬於您的個人化大盤，便於日常監測。例如，這裡基於上述模板和自身業務構建了一個真實的大盤，包含總覽、組件已耗用時間，記憶體使用量率、堆內堆外記憶體、分代GC情況等。