SpringBoot2如何开启Actuator端点监控

Spring Boot Actuator 是 Spring Boot 提供的一个用于监控和管理应用程序的模块。它提供了许多内置的端点（endpoints），通过这些端点可以获取应用程序的运行状态、健康状况、配置信息等。本文将介绍如何在 Spring Boot 2.x 中开启 Actuator 端点监控。

1. 添加依赖

首先，在 pom.xml 文件中添加 Spring Boot Actuator 的依赖：

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

如果你使用的是 Gradle，可以在 build.gradle 文件中添加以下依赖：

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

2. 配置 Actuator 端点

在 application.properties 或 application.yml 文件中，可以对 Actuator 端点进行配置。以下是一些常见的配置项：

2.1 启用所有端点

默认情况下，Spring Boot Actuator 只暴露了 health 和 info 两个端点。要启用所有端点，可以在配置文件中添加以下内容：

management.endpoints.web.exposure.include=*

或者使用 YAML 格式：

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

2.2 禁用特定端点

如果你只想启用部分端点，可以通过以下方式配置：

management.endpoints.web.exposure.include=health,info,metrics

或者使用 YAML 格式：

management:
  endpoints:
    web:
      exposure:
        include: health,info,metrics

2.3 自定义端点路径

默认情况下，Actuator 端点的路径前缀是 /actuator。你可以通过以下配置自定义路径前缀：

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

或者使用 YAML 格式：

management:
  endpoints:
    web:
      base-path: /monitor

3. 访问 Actuator 端点

启动应用程序后，你可以通过浏览器或命令行工具访问 Actuator 端点。例如，访问 /actuator/health 端点可以查看应用程序的健康状况：

curl http://localhost:8080/actuator/health

返回结果可能如下：

{
  "status": "UP"
}

4. 安全配置

由于 Actuator 端点可能暴露敏感信息，建议在生产环境中对端点进行安全配置。可以通过 Spring Security 来保护 Actuator 端点。

4.1 添加 Spring Security 依赖

在 pom.xml 文件中添加 Spring Security 的依赖：

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

或者使用 Gradle：

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

4.2 配置安全策略

在 application.properties 或 application.yml 文件中，可以配置 Spring Security 来保护 Actuator 端点：

spring.security.user.name=admin
spring.security.user.password=password

或者使用 YAML 格式：

spring:
  security:
    user:
      name: admin
      password: password

4.3 自定义安全配置

你还可以通过 Java 配置类来自定义安全策略：

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/actuator/**").hasRole("ADMIN")
                .anyRequest().permitAll()
            .and()
            .httpBasic();
    }
}

5. 总结

通过 Spring Boot Actuator，我们可以轻松地监控和管理应用程序的运行状态。本文介绍了如何在 Spring Boot 2.x 中开启 Actuator 端点监控，并对端点进行配置和安全保护。希望这些内容能帮助你更好地使用 Spring Boot Actuator 来监控你的应用程序。