Day 36 Spring Boot Actuator 監控與管理

2024 iThome 鐵人賽

Modern Web

Spring Boot API 開發：從 0 到 1系列第 37 篇

16th鐵人賽

cashwugeek

2024-10-06 00:02:24

293 瀏覽

分享至

Spring Boot 已經讓我們的開發變得超級簡單，但你有沒有想過，如果能夠即時監控應用程式的狀態，那該有多好

這就是 Spring Boot Actuator 的魔力所在！

什麼是 Spring Boot Actuator

Spring Boot Actuator 是 Spring Boot 框架中的一個子項目

為應用程式提供了一系列的監控和管理功能

這也是應用程式上線後，不可或缺的一環

Actuator 的用途

健康檢查：隨時了解你的應用程式是否健康運行
指標收集：收集各種運行時的指標，如記憶體使用、CPU 負載等
日誌管理：動態調整日誌級別，無需重啟應用
環境屬性：查看當前應用程式的相關設定

Actuator 的功能

Actuator 提供了許多 HTTP 端點（endpoints），每個端點都負責特定的監控或管理功能

例如

/health：顯示應用程式的健康狀態
/metrics：顯示各種應用指標
/info：顯示應用信息
/env：顯示環境變量

因為 Actuator 的端點非常多，這裡只列出一些常見的端點，和一些相關的範例

在 Spring Boot 中加入 Actuator

增加依賴

可以利用 IDE 的功能，方便的加上 Spring Boot Actuator 的依賴

設定 Spring Security

為了測試方便，這裡沒有設定任何存取限制。在實際上，應該要設定特定的角色才能存取

// 這裡只列出 spring actuator 相關的程式碼，而不是全部的程式碼
@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
    http.authorizeHttpRequests((requests) -> requests
        .requestMatchers("/actuator/**").permitAll()
        // .requestMatchers("/actuator/**").hasRole("ADMIN")
    );

    return http.build();
}

設定 application.properties

# 測試使用，可以全部打開看看
management.endpoints.web.exposure.include=*
# 實務上會根據需要打開
#management.endpoints.web.exposure.include=health,info,metrics,env

# 是不是要顯示完整的 health 資料
management.endpoint.health.show-details=always

# 是否啟用相關 info 資訊
management.info.java.enabled=true
management.info.os.enabled=true

# 是否呈現相關 env 的內容
# 測試使用，可以全部打開看看，在正式環境中，應謹慎使用此設定，以避免敏感資訊洩露
management.endpoint.env.show-values=always

也可以使用程式碼來自定應用程式資訊 (Info) 的內容

@Controller
public class AppInfoContributor implements InfoContributor {

    @Override
    public void contribute(Info.Builder builder) {
        builder.withDetail("customInfo", getCustomInfo());
    }

    private Map<String, Object> getCustomInfo() {
        Map<String, Object> customInfo = new HashMap<>();
        customInfo.put("version", "1.0.0");
        customInfo.put("description", "This is a custom info");
        customInfo.put("author", "cash");
        return customInfo;
    }
}