官方文檔：Spring Boot Actuator: Production-ready Features

一、引入依賴

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

二、application.yml文件中開(kāi)啟監(jiān)控

management:
  endpoints:
    enabled-by-default: true #暴露所有端點(diǎn)信息
    web:
      exposure:
        include: "*"  #以web方式暴露

三、具體使用

1. 查看可以監(jiān)控哪些信息：

• localhost:8080/actuator/

2. 根據(jù)1中查出來(lái)的結(jié)果，可以監(jiān)控具體的信息，比如：

• http://localhost:8080/actuator/health 【查看系統(tǒng)健康狀態(tài)】
• localhost:8080/actuator/beans 【查看系統(tǒng)中所有的bean組件】
• localhost:8080/actuator/conditions 【查看系統(tǒng)中激活的組件，如下圖】

localhost:8080/actuator/configprops 【查看系統(tǒng)中配置的屬性，如下圖】

localhost:8080/actuator/env 【查看系統(tǒng)環(huán)境變量】

localhost:8080/actuator/metrics/ 【查看系統(tǒng)可以監(jiān)控哪些指標(biāo)信息，即系統(tǒng)運(yùn)行時(shí)指標(biāo)】

根據(jù)上面查出來(lái)的指標(biāo)，再具體查看每個(gè)指標(biāo)的詳細(xì)信息，比如如下圖查看系統(tǒng)CPU利用率指標(biāo)

• localhost:8080/actuator/metrics/system.cpu.usage

四、具體細(xì)節(jié)使用

比如我現(xiàn)在直接想查看系統(tǒng)是否健康，可以直接發(fā)送

• localhost:8080/actuator/health

這個(gè)請(qǐng)求，如下圖是默認(rèn)返回的信息，只顯示一個(gè)匯總后的結(jié)果告訴我們當(dāng)前服務(wù)是什么狀態(tài)

但是我想的服務(wù)配置了很多東西，比如數(shù)據(jù)庫(kù)，redis, mq等組件，我想知道它們每一個(gè)的健康狀態(tài)，可以在配置文件中針對(duì)每個(gè)監(jiān)控端點(diǎn)進(jìn)行更詳細(xì)的配置，如下：

如上配置好了以后，重新啟動(dòng)項(xiàng)目，再次查看 /actuator/health 端點(diǎn)，返回如下信息：

五、端點(diǎn)開(kāi)啟與禁用

1. 直接使用如下方式是默認(rèn)開(kāi)啟所有監(jiān)控端點(diǎn)，但是某些包含敏感信息的端點(diǎn)我們不想開(kāi)啟，而只想開(kāi)啟某些監(jiān)控端點(diǎn)，該怎么辦呢？

management:
  endpoints:
    enabled-by-default: true #暴露所有端點(diǎn)信息
    web:
      exposure:
        include: "*"  #以web方式暴露

把上面的配置改成如下方式，即單獨(dú)針對(duì)每一個(gè)監(jiān)控端點(diǎn)的開(kāi)啟與禁用進(jìn)行控制

management:
  endpoints:
    enabled-by-default: false#關(guān)閉所有端點(diǎn)監(jiān)控功能
    web:
      exposure:
        include: "*"  #以web方式暴露
  endpoint:
    health:
      show-details: always
      enabled: true
      
    info:
      enabled: true
    
    metrics:
      enabled: true

重啟項(xiàng)目，再次查看監(jiān)控端點(diǎn)信息，如下(只能看到我們想讓你看到的監(jiān)控信息)：

同樣的，在jconsole里面，也是只能看到這些信息，如下圖：

在DOS命令行輸入 jconsole就可以直接打開(kāi)jconsole控制臺(tái)

六、定制Endpoint

說(shuō)明：這里的定制端點(diǎn)是在SpringBoot已有的端點(diǎn)中，添加我們自己定制的一些信息，并沒(méi)有新增監(jiān)控端點(diǎn)（新增監(jiān)控端點(diǎn)，看第7節(jié)）

1. 定制 /actuator/health

比如在訪問(wèn) http://localhost:8080/actuator/health 時(shí)，默認(rèn)顯示系統(tǒng)判斷的那些組件的健康狀態(tài)，如果我們自己想添加一個(gè) 端點(diǎn)(組件)的健康狀態(tài)，按照如下做法：

2. 定制 /actuator/info

直接使用 http://localhost:8080/actuator/info時(shí)，輸入的信息為空，那么我們?nèi)绻朐陧?yè)面展示一些項(xiàng)目的基本信息，比如項(xiàng)目名稱，項(xiàng)目的版本等信息該如何做呢，有如下三種辦法：

（1）直接在配置文件中寫(xiě)死

如下圖：

info:
  appName: boot-admin
  appVersion: 1.0.0

（2）從pom文件中讀取信息

采用（1）中的方法的缺點(diǎn)是我不想把項(xiàng)目的名稱或者版本號(hào)寫(xiě)死，我想動(dòng)態(tài)獲取（比如從maven中動(dòng)態(tài)獲取當(dāng)前項(xiàng)目的項(xiàng)目名稱和版本，因?yàn)轫?xiàng)目名稱或者版本可能會(huì)變動(dòng)）。那么此時(shí)頁(yè)可以直接在配置文件（application.yml）中動(dòng)態(tài)獲取maven配置文件（pom.xml）中的一些基本信息，如下：

重啟項(xiàng)目，訪問(wèn) http://localhost:8080/actuator/info，結(jié)果如下圖：

（3）代碼實(shí)現(xiàn)

第二種方式可以獲取項(xiàng)目的一些基本信息，并且不是寫(xiě)死的，而是從pom文件中自動(dòng)獲取的，但是某些信息只能通過(guò)發(fā)送請(qǐng)求時(shí)，在代碼里面進(jìn)行邏輯處理完成之后才能獲取，所以就引入了第三種方式，即通過(guò)代碼實(shí)現(xiàn)獲取一些項(xiàng)目相關(guān)的信息，代碼實(shí)現(xiàn)如下：

package com.shg.admin.acutuator.info;

import org.springframework.boot.actuate.info.Info;
import org.springframework.boot.actuate.info.InfoContributor;
import org.springframework.stereotype.Component;

import java.util.Collections;

@Component
public class AppInfoInfoContributor implements InfoContributor {


    @Override
    public void contribute(Info.Builder builder) {

        builder.withDetail("msg","你好")
                .withDetail("hello","shg")
                .withDetails(Collections.singletonMap("world","666"));
    }
}

重啟項(xiàng)目，訪問(wèn) http://localhost:8080/actuator/info，結(jié)果如下圖：

3. 定制metrics

SpringBoot默認(rèn)給我們的定制信息如下圖：

上述這些默認(rèn)的指標(biāo)信息不一定能滿足我們的需求，比如我就想單獨(dú)監(jiān)控某個(gè) Controller對(duì)應(yīng)的URL被請(qǐng)求的次數(shù)，此時(shí)就需要自定義一個(gè)mertics，添加到現(xiàn)有的metrics中：

需求：比如我想統(tǒng)計(jì) CityService類(lèi)里面的 selectListCity這個(gè)方法被調(diào)用多少次。代碼如下：

請(qǐng)求Controller的 localhost:8080/city/list 方法后，查詢具體的指標(biāo)如下，可以看到 CityService類(lèi)里面的 selectListCity這個(gè)方法已經(jīng)被調(diào)用了6次。

七. 新增自己的監(jiān)控端點(diǎn)

SpringBoot給我們提供的監(jiān)控端點(diǎn)就是在其官方文檔里面的那些：

Spring Boot Actuator: Production-ready Features

如果我們自己想新增一些監(jiān)控端點(diǎn)，該怎么做呢？

代碼如下：

重啟項(xiàng)目，直接訪問(wèn)：localhost:8080/actuator/ 結(jié)果如下：

訪問(wèn)我們自定的端點(diǎn)，結(jié)果如下：

新增自己的監(jiān)控端點(diǎn)后，通過(guò)jconsole里面也可以看到新增的監(jiān)控端點(diǎn)，如下圖：

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論