淺談SpringBoot的服務(wù)監(jiān)控機(jī)制

任何一個(gè)服務(wù)如果沒(méi)有監(jiān)控，那就是兩眼一抹黑，無(wú)法知道當(dāng)前服務(wù)的運(yùn)行情況，也就無(wú)法對(duì)可能出現(xiàn)的異常狀況進(jìn)行很好的處理，所以對(duì)任意一個(gè)服務(wù)來(lái)說(shuō)，監(jiān)控都是必不可少的。本篇文章將為您簡(jiǎn)單介紹 SpringBoot 的服務(wù)監(jiān)控機(jī)制,Java 實(shí)現(xiàn)監(jiān)控端點(diǎn)，以下是詳情內(nèi)容：

前言

就目前而言，大部分微服務(wù)應(yīng)用都是基于 SpringBoot 來(lái)構(gòu)建，所以了解 SpringBoot 的監(jiān)控特性是非常有必要的，而 SpringBoot 也提供了一些特性來(lái)幫助我們監(jiān)控應(yīng)用。

本文基于 SpringBoot 2.3.1.RELEASE 版本演示。

SpringBoot 監(jiān)控

SpringBoot 中的監(jiān)控可以分為 HTTP 端點(diǎn)和 JMX 兩種方式來(lái)監(jiān)控當(dāng)前應(yīng)用的運(yùn)行狀況和指標(biāo)收集

HTTP Endpoints 監(jiān)控

執(zhí)行器端點(diǎn)允許您監(jiān)視應(yīng)用程序并與之交互。SpringBoot 包括許多內(nèi)置的端點(diǎn)，并允許我們添加自己的端點(diǎn)?？梢酝ㄟ^(guò) HTTP 或 JMX 啟用或禁用每個(gè)端點(diǎn)，并公開(kāi)（使其可以遠(yuǎn)程訪問(wèn)）。每個(gè)端點(diǎn)都有一個(gè)唯一的 id，訪問(wèn)時(shí)可以通過(guò)如下地址進(jìn)行訪問(wèn)：http:ip:port/{id}（SpringBoot 1.x ），而在 SpringBoot 2.x 版本中，默認(rèn)新增了一個(gè) /actuator 作為基本路，訪問(wèn)地址則對(duì)應(yīng)為 :http:ip:port/actuator/{id}。

使用 HTTP 監(jiān)控非常簡(jiǎn)單，在 SpringBoot 項(xiàng)目中，引入如下依賴：

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

默認(rèn)就可以通過(guò)地址 http:localhost:8080/actuator/health，訪問(wèn)之后得到如下結(jié)果：

SpringBoot 中提供了非常多的默認(rèn)端點(diǎn)監(jiān)控，但是出于安全考慮，默認(rèn)情況下有些端點(diǎn)并不是開(kāi)啟狀態(tài)，如 shutdown 端點(diǎn)就是默認(rèn)關(guān)閉的。

內(nèi)置端點(diǎn)

SpringBoot 中默認(rèn)提供的常用內(nèi)置端點(diǎn)如下：

雖然說(shuō)這里的大部分端點(diǎn)都是默認(rèn)開(kāi)啟的，但是默認(rèn)暴露（允許對(duì)外訪問(wèn)）的只有 health 和 info 端點(diǎn)，所以如果需要允許端點(diǎn)對(duì)外暴露，可以通過(guò)如下配置（如果想要暴露所有的端點(diǎn)，則可以直接配置 "*" ）：

management:
 endpoints:
  web:
   exposure:
    include: [health,info,mappings] //或者直接配置 "*"

另外，開(kāi)啟或禁用某一個(gè)端點(diǎn)，也可以通過(guò)通過(guò)如下配置進(jìn)行動(dòng)態(tài)控制：

management.endpoint.<id>.enabled=true

接下來(lái)我們挑選幾個(gè)重點(diǎn)的端點(diǎn)來(lái)介紹一下。

health 端點(diǎn)

health 斷點(diǎn)默認(rèn)只是展示當(dāng)前應(yīng)用健康信息，但是我們可以通過(guò)另一個(gè)配置打開(kāi)詳細(xì)信息，這樣不僅僅會(huì)監(jiān)控當(dāng)前應(yīng)用，還會(huì)監(jiān)控與當(dāng)前應(yīng)用相關(guān)的其他第三方應(yīng)用，如 Redis。

management:
 endpoint:
  health:
   show-details: always

這個(gè)配置打開(kāi)之后，我們連接上 Redis 之后再次訪問(wèn) health 端點(diǎn)，就可以展示 Redis 服務(wù)的健康信息了：

loggers 端點(diǎn)

訪問(wèn) http://localhost:8080/actuator/loggers 可以查看當(dāng)前應(yīng)用的日志級(jí)別等信息：

這里面本身并不特別，但是有一個(gè)功能卻非常有用，比如我們生產(chǎn)環(huán)境日志級(jí)別一般都是 info，但是現(xiàn)在有一個(gè) bug 通過(guò) info 級(jí)別無(wú)法排查，那么我們就可以臨時(shí)修改 log 級(jí)別。

比如上圖中的 ROOT 節(jié)點(diǎn)是 info 級(jí)別，那么我們可以通過(guò) postman 等工具來(lái)發(fā)一個(gè) post 請(qǐng)求修改日志級(jí)別。

修改之后就會(huì)發(fā)現(xiàn)，日志由原來(lái)的 info 變成了 debug：

metrics 端點(diǎn)

metrics 是一個(gè)非常重要的監(jiān)控端點(diǎn)，其監(jiān)控內(nèi)容覆蓋了 JVM 內(nèi)存、堆、類加載、處理器和 tomcat 容器等一些重要指標(biāo)：

可以看到這里面包含了非常多的指標(biāo)，任意訪問(wèn)一個(gè)指標(biāo)就可以查看對(duì)應(yīng)的指標(biāo)信息：

自定義監(jiān)控端點(diǎn)

通過(guò)上面的介紹，可以看到 SpringBoot 提供的監(jiān)控非常強(qiáng)大，但是就算再全面的監(jiān)控也不可能滿足所有人的需求，所以 SpringBoot 也支持自定義監(jiān)控端點(diǎn)。

自定義監(jiān)控端點(diǎn)常用注解

自定義一個(gè)監(jiān)控端點(diǎn)主要有如下常用注解：

• @Endpoint：定義一個(gè)監(jiān)控端點(diǎn)，同時(shí)支持 HTTP 和 JMX 兩種方式。
• @WebEndpoint：定義一個(gè)監(jiān)控端點(diǎn)，只支持 HTTP 方式。
• @JmxEndpoint：定義一個(gè)監(jiān)控端點(diǎn)，只支持 JMX 方式。

以上三個(gè)注解作用在類上，表示當(dāng)前類是一個(gè)監(jiān)控端點(diǎn)，另外還有一些注解會(huì)用在方法和參數(shù)上：

• @ReadOperation：作用在方法上，可用來(lái)返回端點(diǎn)展示的信息（通過(guò) Get 方法請(qǐng)求）。
• @WriteOperation：作用在方法上，可用來(lái)修改端點(diǎn)展示的信息（通過(guò) Post 方法請(qǐng)求）。
• @DeleteOperation：作用在方法上，可用來(lái)刪除對(duì)應(yīng)端點(diǎn)信息（通過(guò) Delete 方法請(qǐng)求）。
• @Selector：作用在參數(shù)上，用來(lái)定位一個(gè)端點(diǎn)的具體指標(biāo)路由。

來(lái)，一起寫(xiě)一個(gè)自己的監(jiān)控端點(diǎn)

定義一個(gè)類，并使用 @Endpoint 注解標(biāo)注標(biāo)識(shí)，同時(shí)定義幾個(gè)方法用 @ReadOperation 和 @WriteOperation 注解來(lái)標(biāo)注：

@Endpoint(id="myEndpoint")
@Component
public class MyEndpoint {
  private String STATUS = "up";
  private String DETAIL = "一切正常";

//  @ReadOperation
//  public String test1(){
//    return "wolf";
//  }

//  @ReadOperation
//  public Map<String,String> test2(){
//    Map<String,String> map = new HashMap();
//    map.put("status","up");
//    return map;
//  }

  @ReadOperation
  public JSONObject test3(){
    JSONObject jsonObject= new JSONObject();
    jsonObject.put("status",STATUS);
    jsonObject.put("detail",DETAIL);
    return jsonObject;
  }

  @ReadOperation
  public JSONObject test3_1(@Selector String name){
    JSONObject jsonObject= new JSONObject();
    if ("status".equals(name)){
      jsonObject.put("status",STATUS);
    }else if ("detail".equals(name)){
      jsonObject.put("detail",DETAIL);
    }
    return jsonObject;
  }

  @WriteOperation//動(dòng)態(tài)修改指標(biāo)
  public void test4(@Selector String name,@Nullable String value){
    if (!StringUtils.isEmpty(value)){
      if ("status".equals(name)){
        STATUS = value;
      }else if ("detail".equals(name)){
        DETAIL = value;
      }
    }
  }
}

@Component 注解表示將該類交給 Spring 進(jìn)行管理，或者也可以再定義一個(gè) Configuration 類來(lái)加載該 Bean 也可以，當(dāng)然，如果我們需要提供給第三方使用，如果無(wú)法保證當(dāng)前包名被掃描，則需要使用 SpringBoot 的自動(dòng)裝配機(jī)制將該類進(jìn)行管理。

@ReadOperation 方法可以返回 String 或者 JSONObject 或者 Map 集合等。參數(shù)上加了 @Selector 注解則表示訪問(wèn)斷端點(diǎn)的時(shí)候可以直接訪問(wèn)子節(jié)點(diǎn)。

完成了上面的類，啟動(dòng) SpringBoot 應(yīng)用，接下來(lái)就可以直接通過(guò) http://localhost:8080/actuator/myEndpoint 進(jìn)行訪問(wèn)了：

同時(shí)，因?yàn)?test3_1 方法使用了 @Selector 注解，所以我們可以通過(guò)這個(gè)方法每一個(gè)指標(biāo)的明細(xì)：

而帶有 @WriteOperation 注解的方法可以用來(lái)修改指標(biāo)，這個(gè)方法需要用 post 進(jìn)行訪問(wèn)，訪問(wèn)的參數(shù)可以直接使用字符串傳參，也可以直接使用 json 進(jìn)行傳參，修改之后再次查看就可以發(fā)現(xiàn)指標(biāo)已經(jīng)被動(dòng)態(tài)修改：

JMX 監(jiān)控

JMX 全稱為 Java Management Extensions，即 Java 管理擴(kuò)展。它提供了對(duì) Java 應(yīng)用程序和 JVM 的監(jiān)控管理。通過(guò)JMX 我們可以監(jiān)控服務(wù)器中各種資源的使用情況以及線程，內(nèi)存和 CPU 等使用情況。

打開(kāi) jdk 下提供的工具 jConsole：

打開(kāi)之后這里會(huì)監(jiān)控到我們已經(jīng)啟動(dòng)的應(yīng)用，雙擊進(jìn)入：

如何手動(dòng)注冊(cè)一個(gè) JMX MBean

定義一個(gè)接口 SystemInfoMBean（注意名字必須要用 MBean 結(jié)尾）：

public interface SystemInfoMBean {
  int getCpuCore();
  long getTotalMemory();
  void shutdown();
}

再定義一個(gè)類實(shí)現(xiàn) SystemInfoMBean 接口，實(shí)現(xiàn)類的明明方式為接口名去掉 MBean：

public class SystemInfo implements SystemInfoMBean {
  @Override
  public int getCpuCore() {
    return Runtime.getRuntime().availableProcessors();
  }
  @Override
  public long getTotalMemory() {
    return Runtime.getRuntime().totalMemory();
  }

  @Override
  public void shutdown() {
    System.exit(0);
  }
}

最后就是需要將該實(shí)現(xiàn)類進(jìn)行注冊(cè)：

public class JmxRegisterMain {
  public static void main(String[] args) throws NotCompliantMBeanException, InstanceAlreadyExistsException, MBeanRegistrationException, MalformedObjectNameException, IOException {
    MBeanServer mBeanServer= ManagementFactory.getPlatformMBeanServer();
    ObjectName objectName=new ObjectName("com.lonely.wolf.note.springboot.actuator.jmx:type=SystemInfo");
    SystemInfo SystemInfo =new SystemInfo();
    mBeanServer.registerMBean(SystemInfo,objectName);//注冊(cè)
    System.in.read();//防止程序結(jié)束
  }
}

運(yùn)行該 main 方法，再打開(kāi) jConsole 就可以看到成功注冊(cè)了一個(gè) MBean：

同樣的，Spring 當(dāng)中只要我們使用了 @@Endpoint 或者 @JmxEndpoint 注解，就會(huì)自動(dòng)幫我們注冊(cè)一個(gè) MBean，其原理也是利用了自動(dòng)裝配機(jī)制。

其他監(jiān)控

除了 SpringBoot 自帶的監(jiān)控之外，也有其他第三方開(kāi)源的強(qiáng)大監(jiān)控系統(tǒng)，如 Prometheus，而且 SpringBoot 也將其進(jìn)行了集成，使用 Prometheus 時(shí)只需要引入如下 jar 包即可：

<dependency>
  <groupId>io.micrometer</groupId>
  <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

當(dāng)然，如果使用 Prometheus 的話需要單獨(dú)安裝，而且一般會(huì)選擇 Prometheus + Grafana 來(lái)共同實(shí)現(xiàn)一個(gè)監(jiān)控平臺(tái)，在這里就不做過(guò)多介紹，如果感興趣的朋友可以自己去了解下這兩種軟件的使用。

總結(jié)

本文主要講述了 Spring Boot actuator 的使用，并分別介紹了其中兩種監(jiān)控類型 HTTP 和 JMX，最后通過(guò)一個(gè)例子來(lái)實(shí)現(xiàn)了自定義的端點(diǎn)，同時(shí)也實(shí)現(xiàn)了手動(dòng)注冊(cè)一個(gè) MBean 的方法。

本篇關(guān)于淺談SpringBoot的服務(wù)監(jiān)控機(jī)制的全部?jī)?nèi)容就介紹到此結(jié)束了,想要了解更多相關(guān)SpringBoot服務(wù)監(jiān)控機(jī)制的其他內(nèi)容請(qǐng)搜索W3Cschool以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持我們！