快捷導(dǎo)航

Spring?Boot?Actuator使用說(shuō)明

更新時(shí)間：2025年02月10日 11:40:20 作者：何中應(yīng)

SpringBootActuator?是一個(gè)用于監(jiān)控和管理?Spring?Boot?應(yīng)用程序的強(qiáng)大工具,通過(guò)引入依賴并配置,可以啟用默認(rèn)的監(jiān)控接口,本文介紹Spring?Boot?Actuator的使用,感興趣的朋友一起看看吧

項(xiàng)目里引入下面這個(gè)依賴

<!--Spring Boot Actuator依賴-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

增加以下配置，開(kāi)放所有默認(rèn)接口

management:
  endpoints:
    web:
      exposure:
        include: "*"

啟動(dòng)項(xiàng)目，瀏覽器輸入：http://127.0.0.1:8081/actuator，可見(jiàn)以下接口信息

輸入某個(gè)詳細(xì)的接口名稱，如：http://127.0.0.1:8081/actuator/health，查詢?cè)敿?xì)的內(nèi)容，如下：

配置文件中，添加配置，查看更詳細(xì)的內(nèi)容

management:
  # 開(kāi)放所有接口
  endpoints:
    web:
      exposure:
        include: "*"
  # 單個(gè)接口設(shè)置
  endpoint:
    health:
      show-details: ALWAYS

如下：

手動(dòng)自定義一個(gè)接口，如下：

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.stereotype.Component;
@Component
@Endpoint(id = "my-actuator")
public class MyActuator {
    @ReadOperation
    public String hello() {
        return "Good Luck";
    }
}

其中@Endpoint(id = "my-actuator")，可以等同于@RequestMapping("/my-actuator")，瀏覽器敲：http://127.0.0.1:8081/actuator/，可見(jiàn)自定義的接口，如下：

瀏覽器輸：http://127.0.0.1:8081/actuator/my-actuator，可見(jiàn)接口返回

使用場(chǎng)景

通過(guò)上面的簡(jiǎn)單使用，可以看到 Spring Boot Actuator與我們常寫(xiě)的接口是分別開(kāi)的，有點(diǎn)像swagger。他可以有以下的使用場(chǎng)景：

健康檢查：默認(rèn)的health就是用來(lái)擴(kuò)展健康檢查的，我們可以在代碼里去擴(kuò)展這個(gè)接口，來(lái)實(shí)現(xiàn)自己的健康檢查操作；
監(jiān)控：可以寫(xiě)一些接口，接口內(nèi)返回運(yùn)行時(shí)系統(tǒng)內(nèi)的一些指標(biāo)，收集起來(lái)，觀測(cè)運(yùn)行時(shí)的情況；
統(tǒng)計(jì)：如上，有些數(shù)據(jù)是“活”的，不存數(shù)據(jù)庫(kù)或者日志里，服務(wù)停止，數(shù)據(jù)就消失了，這些數(shù)據(jù)就可以在接口里返回，用于統(tǒng)計(jì)；
排查問(wèn)題：有些數(shù)據(jù)可能是存在本地緩存，如某個(gè)Map中的，就可以寫(xiě)一個(gè)接口，返回該Map中的數(shù)據(jù)，用于排查問(wèn)題；
……

可以把Spring Boot Actuator當(dāng)做玻璃窗，能觀察到運(yùn)行時(shí)系統(tǒng)的內(nèi)部情況。當(dāng)然，用常規(guī)的接口也能實(shí)現(xiàn)，但不方便，因?yàn)橐紤]如何在鑒權(quán)框架中排出掉這些接口，以及如何對(duì)此類接口進(jìn)行管理，這就不能像Spring Boot Actuator這樣得心應(yīng)手——Spring Boot Actuator可以通過(guò)配置文件來(lái)控制。