SpringBoot中怎麼對actuator進行關閉

SpringBoot對actuator進行關閉

management:
  endpoint:
    health:
      show-details: ALWAYS
  endpoints:
    enabled-by-default: false #关闭监控
    web:
      exposure:
        include: '*'

SpringBoot actuator知識梳理

#Spring Boot的Actuator 。它提供了許多生產級的特性，例如監控和度量Spring Boot應用程式。 Actuator的這些特性可以透過眾多REST端點、遠端shell和JMX來獲得。

【使用環境】

【1】SpringBoot版本2.5.0、JDK11

【2】服務埠9999

新增依賴

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

啟動項目，存取/actuator端點，SpringBoot2.X版本預設只開啟瞭如下端點

可以透過下面的方式開啟其他的端點，如果需要關閉某有些端點可以在exclude中設定。

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

重新啟動項目，可以看到現在展示的端點增加了很多

Actuator端點整理

/autoconfig和/conditions 取得自動設定條件

提供了一份自動設定報告，記錄哪些自動設定條件通過了，哪些沒通過。新版本已經調整為conditions。 Spring Boot自動配置建構於Spring的條件化配置之上。它提供了眾多帶有@Conditional註解的配置類，根據條件決定是否要自動配置這些Bean。 /autoconfig端點提供了一個報告，列出了計算過的所有條件，根據條件是否通過進行分組。

端點：http://localhost:9999/actuator/conditions

【範例】

#上面是失敗的一個條件範例，如圖所示是JdbcTemplate，這個類別可以幫助我們操作資料庫。因為未引入相關的依賴類別所以正如它的提示訊息所說：

“message”: “@ConditionalOnClass did not find required class ‘org.springframework.jdbc.core.JdbcTemplate’”

檢查Classpath沒有要求的JdbcTemplate條件不成立，則不會進行自動配置

/beans 獲得Bean組裝報告

要了解應用程式中Spring上下文的情況，最重要的端點就是/beans。它會傳回一個JSON文檔，描述上下文裡每個Bean的情況，包括其Java類型以及注入的其他Bean。

請求端點：/actuator/beans

#/env端點查看設定屬性

/env端點會產生應用程式可用的所有環境屬性的列表，無論這些屬性是否用到。這其中包括環境變數、JVM屬性、命令列參數，以及applicaition.properties或application.yml檔案提供的屬性。

端點：/actuator/env

/env提供了一些安全性原則保護配置的隱私性。為了避免此類資訊暴露到/env裡，所有名為password、secret、key（或名字中最後一段是這些）的屬性在/env裡都會加上“*”，參考如下：

/mapping請求URL映射

/mapping端點展示了所有@RequestMapping 請求路徑

請求端點：/actuator/mappings

【測試介面】

    @GetMapping(value = "/hello", produces = "application/json;charset=utf-8")
    public String hello(@RequestParam("name") String name) {
        return "hello world";
    }

####每個映射的值都有兩個屬性：bean和method。 bean屬性標識了Spring######Bean的名字，映射源自於這個Bean。 method屬性是映射對應方法的全限定方法簽章。 #########/metrics執行時間指標監控#########/metrics為我們提供了對執行時間度量情況的一個監控，能夠在運行時快速檢查應用程式。 ######端點：/actuator/metrics################主要的監控事項如下：############

/metrics端点会返回所有的可用度量值，但你也可能只对某个值感兴趣。要获取单个值，请求时可以在URL后加上对应的键名。

如上图所示，查询jvm最大内存，结果值大约为6G。

/httptrace 追踪Web请求

/httptrace端点能报告所有Web请求的详细信息，包括请求方法、路径、时间戳以及请求和响应的头信息。

【请求端点】/actuator/httptrace

默认情况下httptrace没有启用，它要求一个HttpTraceRepository 的对象Bean.

在系统中创建如下配置，提供一个HttpTraceRepository 类型的Bean,这里选择的是InMemoryHttpTraceRepository内存存储的方式。该方式默认提供最新的100条请求记录。

import org.springframework.boot.actuate.trace.http.HttpTraceRepository;
import org.springframework.boot.actuate.trace.http.InMemoryHttpTraceRepository;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class HttpTraceActuatorConfiguration {

    @Bean
    public HttpTraceRepository httpTraceRepository() {
        return new InMemoryHttpTraceRepository();
    }

}

/dump 导出线程快照

/dump端点会生成当前线程活动的快照。完整的线程导出报告里会包含应用程序的每个线程。其中包含很多线程的特定信息，还有线程相关的阻塞和锁状态。

【请求端点】/threaddump

【测试】

     Thread thread = new Thread(() -> {
            try {
                Thread.sleep(1000000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }, "测试线程");
        thread.start();

/shutdown 优雅的关闭应用程序

/shutdown可以让应用服务优雅的关闭，默认是关闭的。假设你要关闭运行中的应用程序。比方说，在微服务架构中，你有多个微服务应用的实例运行在云上，其中某个实例有问题了，你决定关闭该实例并重启这个有问题的应用程序。在这个场景中，Actuator的/shutdown端点就很有用了。

优雅的关闭和kill -9的方式是相对的，它不会粗暴的立马关闭应用，而是会释放相关链接以及执行SpringBoot容器停止后的一些操作，然后再关闭应用。

【端点】/actuator/shutdown 要求POST请求方式

【示例】

在应用中添加一个关闭前处理的钩子方法

        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
            System.out.println("关闭应用，释放资源");
        }));

可以看到通过/actuator/shutdown关闭应用可以触发这些关闭处理的钩子函数，方便我们在应用停止时关闭一些连接以及做一些其他的处理。

整理

【1】上面实践了一些Actuator端点示例，虽然Actuator提供的功能很强大，但是在如今的集群化，K8S容器化应用部署下，这些直接访问某些应用的情况就变得很少了，比如监控Zipkin 、Spring Cloud Sleuth等等，内存监控这一块K8S容器化平台也有很多。但是，去学习实践这样的一个工具也是很值得的，如果后面有类似监控、关闭应用、获取请求URL映射、获取配置等等，那么我们就可以去看看Actuator是如何做的，学习和扩展。

【2】本次的学习时看的《SpringBoot实战》书籍的学习笔记，该书Actuator章节后在后面也提及了很多进阶的知识，因为具体应用场景不多，下面就简单的整理下，把一些知识点记录下来，如果后面需要在重点实践学习下。

【3】《SpringBoot实战》书籍关于Actuator介绍的一些使用可能在当下的版本中有些出入，这里贴上官方文档地址，参考对比下https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.enabling

【4】Actuator通过REST端点提供了不少非常有用的信息。另一个深入运行中应用程序内部的方式是使用远程shell。Spring Boot集成了CRaSH，一种能嵌入任意Java应用程序的shell。Spring Boot还扩展了CRaSH，添加了不少Spring Boot特有的命令，提供了与Actuator端点类似的功能。该工具附上应用上，会在启动时提供一个访问秘钥，我们通过ssh user@localhost -p 2000 的方式就可以去访问，并且执行一些命令去查看应用数据。

【5】除了REST端点和远程shell，Actuator还把它的端点以MBean的方式发布了出来，可以通过JMX来查看和管理。使用JMX是管理Spring Boot应用程序的一个好方法，如果你已在用JMX管理应用程序中的其他MBean，则尤其如此。

【6】前面我們使用了Actuator所提供好的一些內建端點，我們也可以依照自己的需求擴充客製化Actuator。

• 實際上，Actuator有多種自訂方式，包括以下五項。

• 1：重新命名端點。將預設的端點修改為我們自訂的端點位址。

• 2：啟用和停用端點。

• 3：自訂度量資訊。

• 4：建立自訂倉庫來儲存追蹤資料。

• 5：插入自訂的健康指示器。

【7】到這裡我們可以看到透過Actuator我們可以看到系統的許多信息，這對於開發者而言很好，但是在安全層面來說，如果不加以限制，那麼系統的安全將會有很大隱患。 Actuator的端點保護可以用和其他URL路徑一樣的方式——使用Spring Security。在Spring Boot應用程式中，這意味著將Security起步依賴作為構建依賴加入，然後讓安全相關的自動配置來保護應用程序，其中當然也包括了Actuator端點。舉例來說，你想要保護/shutdown端點，只允許擁有ADMIN權限的使用者存取。

以上是SpringBoot中怎麼對actuator進行關閉的詳細內容。更多資訊請關注PHP中文網其他相關文章！