@目錄

SpringBoot官方提供了spring-boot-starter-actuator場景啟動器用於系統的監控管理，可以通過HTTP，JMX，SSH協議來進行操作，自動得到審計、健康及指標資訊等

環境準備：

• JDK 1.8
• SpringBoot2.2.1
• Maven 3.2+
• 開發工具
  • IntelliJ IDEA
  • smartGit

建立一個SpringBoot Initialize專案，詳情可以參考我之前部落格：SpringBoot系列之快速建立專案教程

要將執行器新增到基於Maven的專案中，請檢查新增以下“ Starter”依賴項：

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

專案啟動成功後，如果沒設定context-path，專案會自動加入/actuator作為字首，大部分端點是預設啟動的，不過要通過web瀏覽器方式訪問的只有health、info端點

可以通過配置修改預設字首

management.endpoints.web.base-path=/actuator

通用的端點(http、Jms、ssh方式都能訪問)：

GET方式呼叫health端點，返回json資訊

Web 應用程式（Spring MVC、Spring WebFlux 或 Jersey），則可以使用以下附加端點，這個應該是2.x版本才加上的

啟用端點，修改配置，語法management.endpoint.[端點名稱].enabled=true

management.endpoint.shutdown.enabled=true

下表顯示了內建端點和預設暴露情況，以JMX、WEB(Http)做對比：

要更改暴露的端點，請使用以下特定的 include 和 exclude 屬性：

include 屬性列出了暴露的端點的 ID。exclude 屬性列出了不應暴露的端點的 ID。exclude 屬性優先於 include 屬性。

例子：
關閉jmx訪問所有端點的許可權，只讓其能訪問health、info

management.endpoints.jmx.exposure.include=health,info

啟用web訪問所有端點，除env之外的許可權

management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env

注意

* 在 YAML 中具有特殊含義，因此如果要包含（或排除）所有端點，請務必新增引號，如下所示：

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

自定義InfoContributor

package com.example.springboot.actuator.actuate.health;

import java.util.Collections;

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

@Component
public class ExampleInfoContributor implements InfoContributor {

    @Override
    public void contribute(Info.Builder builder) {
        builder.withDetail("example",
                Collections.singletonMap("key", "value"));
    }

}

可以在瀏覽器或者postman呼叫：

跨域支援配置

management.endpoints.web.cors.allowed-origins=http://localhost
management.endpoints.web.cors.allowed-methods=GET,POST

定置端點：

management.endpoint.info.enabled=true
management.endpoint.info.cache.time-to-live=10s

ok，actuator的知識點比較多，詳情請參考官方文件，本部落格參考官方文件，做了簡單記錄，僅僅作為入門參考手冊

程式碼例子下載：code download