Spring Boot Actuator端點大揭秘：輕松監控你的應用程序

作者：迷路的架構師 2023-04-11 16:04:19

Spring Boot Actuator 是一個用于監控和管理 Spring Boot 應用程序的子項目。它提供了一系列內置的端點（Endpoints），這些端點可以用于查看應用程序的狀態、運行情況和運行指標。

一、Spring Boot Actuator端點簡介

1.1 什么是Actuator端點

Spring Boot Actuator 是一個用于監控和管理 Spring Boot 應用程序的子項目。它提供了一系列內置的端點（Endpoints），這些端點可以用于查看應用程序的狀態、運行情況和運行指標。Actuator 端點可以以 HTTP、JMX 或其他形式暴露給外部系統，便于運維人員對應用程序進行監控、診斷和管理。

1.2 端點的作用和功能

Actuator端點主要用于實現以下功能：

提供應用程序的健康檢查，包括數據庫連接、緩存、消息隊列等
收集應用程序的度量數據，例如內存使用情況、GC情況、線程狀態等
查看應用程序的配置信息，包括環境變量、系統屬性、配置文件中的屬性等
管理應用程序的日志，包括查看和動態修改日志級別
獲取應用程序的 Spring Bean 信息，以及應用程序的元數據等
提供應用程序的關閉功能等

1.3 Actuator端點的默認配置

Spring Boot Actuator 默認提供了一系列內置端點，這些端點在開發環境下可以直接訪問，但在生產環境中，可能需要對端點進行權限控制和暴露策略的配置。Actuator的端點可以通過 application.properties 或 application.yml 文件進行配置。例如，可以通過配置
management.endpoints.web.exposure.include 來控制哪些端點暴露給外部訪問，或者通過 management.endpoints.web.base-path 來修改端點的URL路徑。

二、內置端點詳解

Spring Boot Actuator 提供了許多內置端點，用于查看和管理應用程序的不同方面。以下是一些常用端點的詳細介紹：

2.1 /actuator/health

這個端點用于查看應用程序的健康狀態。它會檢查各個組件的狀態，如數據庫連接、緩存、消息隊列等。返回的狀態包括 UP（正常）、DOWN（異常）和 OUT_OF_SERVICE（維護中）等。

2.2 /actuator/info

此端點用于展示應用程序的基本信息，如版本號、構建時間等。這些信息通常來源于應用程序的配置文件或構建系統。

2.3 /actuator/metrics

此端點用于查看應用程序的度量數據。它收集了關于內存使用、GC、線程狀態等方面的數據。可以通過添加參數來查看特定度量的詳細信息，例如：

/actuator/metrics/jvm.memory.used。

2.4 /actuator/beans

此端點用于查看應用程序中的所有 Spring Bean。它顯示了 Bean 的名稱、類型、作用域和所屬的 ApplicationContext 等信息。

2.5 /actuator/env

此端點用于查看應用程序的環境信息，包括環境變量、系統屬性、配置文件中的屬性等。可以通過添加參數來查看特定屬性的值，例如：/actuator/env/server.port。

2.6 /actuator/loggers

此端點用于查看和管理應用程序的日志。它顯示了當前應用程序中所有 Logger 的名稱和日志級別。通過發送 POST 請求，還可以動態修改某個 Logger 的日志級別。

2.7 /actuator/shutdown

這個端點用于關閉應用程序。它需要配置
management.endpoint.shutdown.enabled 為 true 才能啟用。在生產環境中，通常需要對此端點進行權限控制，以防止誤操作。

2.8 其他端點

除了以上常用端點外，Spring Boot Actuator 還提供了一些其他端點，例如：

/actuator/auditevents：查看應用程序的審計事件
/actuator/threaddump：獲取應用程序的線程轉儲信息
/actuator/heapdump：獲取應用程序的堆轉儲信息
/actuator/mappings：查看應用程序的 URL 映射信息

三、端點配置與定制

在實際項目中，我們可能需要對 Spring Boot Actuator 的端點進行一些定制，以滿足特定的需求。本節將介紹如何對端點進行配置和定制。

3.1 控制端點訪問權限

訪問端點可能涉及敏感信息，我們需要對端點進行權限控制。可以通過集成 Spring Security 或自定義攔截器實現訪問權限控制。例如，僅允許具有 ADMIN 角色的用戶訪問 /actuator/shutdown 端點。

3.2 端點暴露策略

可以通過management.endpoints.web.exposure.include 和 management.endpoints.web.exposure.exclude 配置項來控制哪些端點應該被暴露。默認情況下，僅暴露 /actuator/health 和 /actuator/info 端點。例如，暴露所有端點：

management.endpoints.web.exposure.include=*

或者僅暴露某些特定端點：

management.endpoints.web.exposure.include=health,info,metrics,env

3.3 修改端點的 URL 路徑

默認情況下，所有端點的路徑都是以 /actuator 開頭的。我們可以通過
management.endpoints.web.base-path 配置項修改這個前綴。例如，將其更改為 /admin：

management.endpoints.web.base-path=/admin

3.4 端點響應內容定制

默認情況下，某些端點的響應內容可能不包含我們關心的所有信息。可以通過實現自定義的 EndpointFilter 來定制端點的響應內容。例如，可以為 /actuator/health 端點添加自定義的健康指標。或者通過繼承并重寫原有端點的方法來實現定制。

通過這些定制方法，我們可以使 Spring Boot Actuator 更好地適應實際項目需求。

四、創建自定義端點

在某些情況下，內置的端點無法滿足我們的需求，因此我們需要創建自定義端點。本節將介紹自定義端點的實現方式、應用場景舉例以及如何注冊和配置自定義端點。

4.1 自定義端點的實現方式

要創建自定義端點，需要實現org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint 接口或 org.springframework.boot.actuate.endpoint.annotation.Endpoint 接口。其中，RestControllerEndpoint 接口允許我們創建基于 Web 的端點，而 Endpoint 接口則適用于其他類型的端點。

4.2 注冊和配置自定義端點

創建自定義端點后，需要將其注冊到 Spring Boot Actuator。我們可以通過將自定義端點作為 Bean 注冊到 Spring 上下文來實現。例如：

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.stereotype.Component;

@Component
@Endpoint(id = "cache-status")
public class CacheStatusEndpoint {

    @ReadOperation
    public CacheStatus getCacheStatus() {
        // 在這里實現獲取緩存狀態的邏輯
        // 例如，從緩存管理器中獲取相關信息
        CacheStatus cacheStatus = new CacheStatus();
        cacheStatus.setCacheSize(100);
        cacheStatus.setHitCount(200);
        cacheStatus.setMissCount(50);
        return cacheStatus;
    }
}

在上面的代碼中，我們首先使用@Endpoint注解來指定端點的ID（即cache-status）。然后，我們定義了一個getCacheStatus()方法，使用@ReadOperation注解來表示這是一個讀操作。此方法應返回一個表示緩存狀態的對象（例如，CacheStatus類）。

接下來，我們需要定義CacheStatus類：

public class CacheStatus {

    private int cacheSize;
    private int hitCount;
    private int missCount;

    // 省略 getter 和 setter 方法
}

接下來，我們需要為自定義端點配置訪問權限、暴露策略等。這可以通過在 application.properties 文件中添加相關配置來實現。例如：

management.endpoints.web.exposure.include=health,info,cache-status

這將使得我們的自定義端點 /actuator/cache-status 能夠被訪問。

五、端點數據監控與可視化

在本節中，我們將介紹如何利用Spring Boot Actuator端點數據進行監控與可視化，從而更好地了解應用程序的運行狀況。

5.1 使用JMX監控端點

Java Management Extensions（JMX）是Java平臺的一種技術，允許對Java應用程序進行管理和監控。Spring Boot Actuator默認支持將端點數據暴露到JMX。要使用JMX監控端點，請確保在應用程序的application.properties或application.yml文件中啟用了JMX：

management.endpoints.jmx.exposure.include=*

然后，您可以使用JMX客戶端（如Java Mission Control、VisualVM等）連接到應用程序的JMX端口，查看和操作暴露的端點數據。

5.2 使用Prometheus和Grafana進行可視化監控

Prometheus是一個流行的開源監控系統，與Grafana這個數據可視化工具結合使用，可以為Spring Boot Actuator端點數據提供強大的可視化監控功能。

首先，需要在Spring Boot應用程序中集成Prometheus。添加相應的依賴并配置application.properties或application.yml文件，以啟用Prometheus端點：

management.endpoints.web.exposure.include=*
management.metrics.export.prometheus.enabled=true

接下來，需要配置Prometheus來抓取Spring Boot應用程序的數據。在Prometheus的配置文件中（通常是prometheus.yml），添加以下內容：

scrape_configs:
  - job_name: 'spring-boot-actuator'
    metrics_path: '/actuator/prometheus'
    static_configs:
      - targets: ['localhost:8080'] # 將此處替換為Spring Boot應用程序的實際地址

最后，在Grafana中添加Prometheus數據源，并創建儀表板來展示和分析Spring Boot Actuator端點的數據。如下圖所示：

5.3 集成其他監控工具

Spring Boot Actuator還可以與其他監控工具集成，例如Datadog、InfluxDB、New Relic等。要集成這些工具，通常需要在應用程序中添加相應的依賴并進行一些配置。具體的集成步驟和配置方式請參考官方文檔或相關教程。

六、總結

在本文中，我們詳細介紹了Spring Boot Actuator端點的相關內容，下面對全文進行概括總結。

6.1 Spring Boot Actuator端點的優勢

提供豐富的內置端點，可以輕松獲取應用程序的運行時信息，如健康狀況、度量數據、環境信息等。
端點配置靈活，支持定制訪問權限、路徑和響應內容。
可以輕松創建自定義端點，滿足特定業務需求。
支持與各種監控工具集成，便于進行數據監控與可視化。

6.2 注意事項和最佳實踐

謹慎配置端點的訪問權限，確保敏感信息不被泄露。
合理地暴露和定制端點，以滿足實際需求，但避免不必要的開銷。
使用自定義端點時，遵循單一職責原則，確保每個端點專注于一個特定功能。
結合實際業務場景選擇合適的監控工具，進行可視化分析，以便于快速發現和解決問題。

6.3 對未來發展的展望

隨著微服務和容器化技術的發展，對于應用程序的監控和管理需求將越來越復雜。Spring Boot Actuator的端點功能將繼續完善，為開發者提供更加強大的監控工具。同時，我們期待更多的第三方監控工具與Actuator集成，幫助開發者更好地管理和優化其應用程序。

責任編輯：華軒來源：今日頭條

Spring Boo 端點運維