1. Actuator 的入門及配置

1.1 安裝和使用 Actuator

我們可以通過 Maven 或 Gradle 將 Actuator 添加到我們的 Spring Boot 應用程序中。Maven 的依賴如下

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

Gradle 的依賴如下：

implementation 'org.springframework.boot:spring-boot-starter-actuator'

添加依賴后，我們只需要啟動我們的應用程序即可開始使用 Actuator。默認情況下，Actuator 會向應用程序暴露以下 URI：

• /actuator/auditevents：顯示當前配置的審核事件信息
• /actuator/beans：顯示應用程序中所有 Bean 的完整名稱列表
• /actuator/conditions：顯示自動配置類及其應用情況的信息
• /actuator/configprops：顯示所有 Spring Boot 配置文件及其對應值的詳細信息
• /actuator/env：顯示應用程序當前環(huán)境變量和屬性的詳細信息
• /actuator/flyway：顯示 Flyway 數(shù)據(jù)庫遷移信息的詳細信息
• /actuator/health：顯示應用程序的健康狀況
• /actuator/info：顯示應用程序相關信息
• /actuator/mappings：顯示 Spring MVC 控制器映射的詳細信息
• /actuator/metrics：顯示各種 JVM 指標、計數(shù)器和度量數(shù)據(jù)的詳細信息
• /actuator/prometheus：將指標暴露為 Prometheus 格式，以便在 Grafana 或其他監(jiān)控系統(tǒng)中使用
• /actuator/scheduledtasks：顯示應用程序中所有調度任務的詳細信息
• /actuator/sessions：允許查看和失效會話 ID
• /actuator/shutdown：關閉應用程序（需要加入 actuator/shutdown 配置）

1.2 Actuator 的基本配置

Actuator 默認是開啟的，并暴露所有端點，我們甚至可以在瀏覽器中直接訪問上面提到的 URI。但是，在生產環(huán)境中，我們通常不希望所有端點都對外暴露。這時，我們需要對 Actuator 進行一些配置。

在 application.properties 或 application.yml 文件中添加如下配置：

# 關閉具體某個端點，格式為management.endpoint.<id>.enabled=false
management.endpoint.shutdown.enabled=true
# 開啟所有端點的基礎功能，格式為management.endpoints.<id>.<option-name>
management.endpoints.web.exposure.include=*

上述配置將關閉 shutdown 端點，并開放所有端點。除了以上參量，還可以通過 management.server.port 配置 Actuator 的 HTTP 端口和 management.server.ssl 配置 SSL。

2. Actuator 的端點

Actuator 中各個端點描述如下：

2.1 /actuator/health

該端點提供有關應用程序健康狀況的詳細信息。通過檢查數(shù)據(jù)庫、緩存、消息代理等檢查資源的狀態(tài)，Health Indicators 能夠確定應用程序是否正常運行。默認情況下，該端點顯示以下信息：

{
    "status": "UP"
}

如果應用程序是正常運行的，它會返回 UP，否則將返回 DOWN，并向用戶提供有關錯誤的詳細信息。

2.2 /actuator/info

該端點展示與應用程序相關的任何附加信息。如：版本，構建時間等。在應用程序訪問時，返回一個自定義 JSON 格式的響應?？梢酝ㄟ^在 application.yml 或 application.properties 文件中添加鍵值對來定制信息。

例如：

info.app.name=My Application
info.app.description=A demo application
info.app.version=1.0.0

訪問該端點，將返回如下響應：

{
    "app": {
        "description": "A demo application",
        "name": "My Application",
        "version": "1.0.0"
    }
}

2.3 /actuator/metrics

該端點提供了可以收集和監(jiān)控的度量指標的詳細信息。Spring Boot 提供了一些默認的度量指標，如系統(tǒng) CPU 使用率、內存使用情況、HTTP 請求延遲等。此外，Spring Boot 還支持使用 Micrometer 框架創(chuàng)建自定義的度量指標。

在 /actuator/metrics 端點下，有許多子路徑，每個子路徑中包含一些度量項。例如，我們可以查看 Tomcat 正在監(jiān)聽的連接數(shù)和活動線程數(shù)等：

{
    "connections": {
        "active": 13,
        "max": 1000,
        "total": 29
    },
    "threads": {
        "daemon": 7,
        "total": 22
    }
}

2.4 /actuator/beans

該端點提供了應用程序所有 Bean 的完整列表，包括它們的相關信息。需要注意的是，Actuator 只顯示由 Spring IOC 容器管理的 Bean 信息。

2.5 /actuator/env

該端點展示應用程序當前環(huán)境變量和屬性的詳細信息?？梢允褂?/actuator/env/<key> 端點獲取指定 key 的值，也可以通過 POST 請求，修改或添加屬性。

2.6 /actuator/mappings

該端點提供了所有 Spring MVC 控制器映射的詳細信息，包括請求 URL、處理器方法、HTTP 方法等等，并按照優(yōu)先級遞減的順序進行排序。例如，如下代碼：

@RestController
@RequestMapping("/hello")
public class HelloController {
    @GetMapping("/world")
    public String greeting() {
        return "Hello, world!";
    }
}

訪問 /actuator/mappings ，將返回：

{
    "contexts": {
        "application": {
            "mappings": {
                "dispatcherServlets": {
                    "dispatcherServlet": {
                        "mvcHandlerMappings": {
                            "/hello": {
                                "methods": [],
                                "params": {},
                                "headers": {},
                                "consumes": [],
                                "produces": [],
                                "custom": {}
                            },
                            "/hello/world": {
                                "bean": "helloController",
                                "method": "greeting",
                                "beanType": "com.example.demo.HelloController",
                                "args": [],
                                "responseDetails": {
                                    "status": 200,
                                    "headers": {},
                                    "content": {
                                        "id": "1",
                                        "name": "Tom"
                                    }
                                },
                                "methods": [
                                    "GET"
                                ],
                                "params": {},
                                "headers": {},
                                "consumes": [],
                                "produces": [],
                                "custom": {}
                            },
                            ...
                        }
                    }
                }
            }
        }
    }
}

2.7 /actuator/auditevents

該端點提供了所有 Spring Boot 應用程序所執(zhí)行的審核事件的詳細信息，包括事件名稱、類型、時間戳和調用者等。此外，還支持通過 Spring Security 的安全審核事件等。

2.8 /actuator/flyway

該端點展示 Flyway 數(shù)據(jù)庫遷移信息的詳細信息，包括已應用遷移的版本和狀態(tài)等。

2.9 /actuator/scheduledtasks

該端點展示應用程序中所有調度任務的詳細信息。

2.10 /actuator/sessions

該端點允許查看和失效會話 ID。

3. 自定義 Actuator 端點

除了使用 Actuator 默認端點之外，我們還可以根據(jù)自己的業(yè)務需求自定義 Actuator 端點。

3.1 編寫自定義 Endpoints

自定義 Actuator 端點需要實現(xiàn) Endpoint 接口，并重寫 getId() 和 invoke() 方法。例如，以下代碼實現(xiàn)了一個名為 MyEndpoint 的自定義端點：

@Component
public class MyEndpoint implements Endpoint<Map<String, Object>> {
    @Override
    public String getId() {
        return "my-endpoint";
    }
    @Override
    public Map<String, Object> invoke() {
        Map<String, Object> result = new HashMap<>();
        result.put("name", "My name is Actuator");
        return result;
    }
}

3.2 暴露自定義 Endpoints

實現(xiàn)自定義 Endpoints 后，我們需要通過設置來公開它們。在 application.yml 中添加以下內容：

management:
  endpoints:
    web:
      exposure:
        include: my-endpoint

這將允許我們通過訪問 /actuator/my-endpoint 端點來查看自定義的端點信息。

4. Actuator 的監(jiān)控和管理功能

4.1 配置度量指標

Actuator 提供了很多度量指標，但默認只包含一些 JVM 層面的指標。如果我們需要檢測自己應用程序的度量指標，那么可以使用 Micrometer 庫來幫助我們完成。它是一個跨度量系統(tǒng)和時間序列數(shù)據(jù)庫的工具庫，支持多種后端存儲如 Prometheus、Graphite 和 InfluxDB。使用 Micrometer，我們可以在 Actuator 中創(chuàng)建自定義度量指標：

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Component;
@Component
public class CustomMetrics {
    private final MeterRegistry meterRegistry;
    private final Counter requestsCounter;
    public CustomMetrics(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;
        this.requestsCounter = Counter.builder("custom_requests_counter")
                .description("A counter for counting custom requests.")
                .register(meterRegistry);
    }
    public void incrementRequests() {
        requestsCounter.increment();
    }
}

在上述代碼中，我們創(chuàng)建了一個名為 CustomMetrics 的類，它是一個 Spring bean，并使用 MeterRegistry 注冊了一個名為 custom_requests_counter 的度量計數(shù)器。此外，還定義了一個 incrementRequests() 方法，以便我們可以在代碼中增加請求計數(shù)器。我們還可以添加其他類型的指標，如 Gauge、Timer 和 DistributionSummary。

4.2 監(jiān)控和管理應用程序

Actuator 還提供了一些有用的監(jiān)控和管理功能，讓我們可以更方便地跟蹤和管理應用程序。

4.2.1 健康檢查

Actuator 的 /actuator/health 端點提供了應用程序的健康狀況，我們可以通過檢查該端點來確定應用程序是否正常運行。如果應用程序出現(xiàn)故障，該端點將顯示 DOWN 狀態(tài)，并提供有關錯誤的詳細信息。

4.2.2 角色和權限

Actuator 支持基于角色的訪問控制，可以限制某些用戶或組的訪問。可以通過設置 management.endpoint.<id>.roles 屬性配置端點的角色。例如，以下代碼將 /actuator/shutdown 端點限制為 ADMIN 角色：

management.endpoint.shutdown.roles=ADMIN

4.2.3 外部配置

Actuator 可以通過外部配置文件進行配置?？梢栽谕獠颗渲梦募性O置以下鍵來控制 Actuator 的行為：

• management.endpoints.enabled-by-default：是否啟用所有端點（默認為 true）
• management.endpoints.jmx.exposure.exclude：要排除的端點 JMX MBean 名稱
• management.endpoint.<id>.enabled：指定是否啟用特定端點
• management.endpoint.<id>.sensitive：指定特定端點是否包含敏感信息

4.2.4 采樣周期

Actuator 還支持將某些端點的采樣周期設置為非默認值，以在一定時間間隔內定期輪詢信息?？梢酝ㄟ^ management.endpoint.<id>.time-to-live 屬性配置采樣周期。例如，以下代碼將 /actuator/metrics 端點的采樣周期設置為 30 秒：

management.endpoint.metrics.time-to-live=30s

5. Actuator 的安全保護

在生產環(huán)境中，Actuator 的安全保護非常重要。Actuator 支持基于 Spring Security 的安全保護，可以使用 Spring Security 配置來授權 Actuator 端點的訪問。

5.1 添加 Spring Security 依賴

要使用 Spring Security，我們需要在項目中添加以下 Maven 依賴：

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

5.2 配置 Spring Security

完成依賴添加后，我們需要配置 Spring Security，以保護 Actuator 端點。以下是一個簡單的 Spring Security 配置示例：

@Configuration
@EnableWebSecurity
public class ActuatorSecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .requestMatchers(EndpointRequest.to("health", "info")).permitAll()
            .requestMatchers(EndpointRequest.toAnyEndpoint()).hasRole("ACTUATOR")
            .and().httpBasic();
    }
}

在上述代碼中，我們創(chuàng)建了一個名為 ActuatorSecurityConfig 的 Spring Security 配置類，并配置了 /actuator/health 和 /actuator/info 端點的公開訪問權限。對于其他端點，則需要用戶具有 ACTUATOR 角色才能訪問。此外，還啟用了 HTTP 基本身份驗證，以便在調用受保護的端點時要求用戶進行身份驗證。

5.3 添加用戶和角色

完成 Spring Security 配置后，我們還需要為 Actuator 添加用戶和角色?？梢酝ㄟ^在 application.properties 或 application.yml 文件中設置以下鍵來配置用戶名、密碼和角色：

spring.security.user.name=actuator
spring.security.user.password=actuator-password
spring.security.user.roles=ACTUATOR

在上述配置中，我們創(chuàng)建了一個名為 actuator、密碼為 actuator-password，且擁有 ACTUATOR 角色的用戶。

以上就是SpringBoot監(jiān)控模塊Actuator的用法詳解的詳細內容，更多關于SpringBoot監(jiān)控模塊Actuator的資料請關注腳本之家其它相關文章！

最新評論