Spring Boot进阶 - Actuator监控

bsfc.tech大约 5 分钟框架Spring Boot

Spring Boot 应用监控是指对基于 Spring Boot 构建的应用程序进行性能、健康状况、资源使用情况、日志记录、审计追踪等多方面的实时监控和管理。Spring Boot 自身提供了一个强大的模块 —— Spring Boot Actuator，它极大地简化了对 Spring Boot 应用的监控工作。以下是对 Spring Boot 应用监控的详细说明：

Spring Boot Actuator

1. 核心功能

Spring Boot Actuator 提供了一系列生产级别的功能，包括但不限于：

健康检查（Health Checks）：检查应用程序各个组件（如数据库连接、缓存、磁盘空间等）的健康状态，并通过 /health 端点返回汇总信息。
指标收集（Metrics）：收集各种应用指标，如 JVM 内存使用、CPU 利用率、HTTP 请求统计、数据库连接池状态等。这些指标可通过 /metrics 或 /actuator/metrics 端点访问。
审计（Auditing）：记录应用中的重要事件，如用户登录、系统启动、关键操作等。
HTTP 跟踪（HTTP Tracing）：跟踪 HTTP 请求和响应的详细信息，有助于诊断网络通信问题。
端点管理（Endpoints）：内置多种端点，允许通过 REST API 查看应用配置、环境变量、beans列表、线程信息、堆栈跟踪等。

2. 端点配置

要启用 Spring Boot Actuator，只需在项目中添加 spring-boot-starter-actuator 依赖。通过 application.properties 或 application.yml 文件可以配置端点的暴露方式（HTTP、JMX等）、安全性以及是否公开特定端点。

例如：

management.endpoints.web.exposure.include=health,info,metrics,loggers
management.endpoint.health.show-details=always

3. 安全配置

由于 Actuator 端点可能暴露敏感信息，通常需要对其进行安全保护。这通常通过集成 spring-boot-starter-security 依赖，并配置 Spring Security 来实现。例如，可以创建一个继承 WebSecurityConfigurerAdapter 的配置类，重写其 configure 方法以限制对 Actuator 端点的访问。

除了使用 Actuator 提供的内置指标，还可以自定义监控指标。例如，可以使用 Micrometer（Actuator 默认支持的度量库）创建 Counter 和 Gauge 类型的指标。Counter 用于累计值（如请求总数），通常以 _total 结尾；而 Gauge 用于表示可增可减的瞬时值（如当前内存使用量）。自定义指标可以通过 MeterRegistry 注入并调用相应方法（如 counter().increment() 或 gauge().set(value)）来更新。

5. 日志监控与审计

Spring Boot 支持多种日志框架（如 Logback、Log4j2），通过配置可以实现日志级别调整、日志文件轮转、远程日志收集等。审计信息可以通过 Actuator 的审计端点或集成第三方审计工具来获取。

6. 可视化监控

虽然 Actuator 提供了丰富的 API，但直接通过 API 查看监控数据可能不够直观。为此，可以使用 Spring Boot Admin 这样的可视化监控工具。Spring Boot Admin 是一个开源项目，它可以自动发现或手动注册 Spring Boot 应用，并通过其前端界面展示应用状态、指标、日志、配置等信息。Spring Boot Admin 本身是一个独立的应用，需单独部署，并在被监控的应用中添加 Spring Boot Admin Client 依赖。

7. 第三方组件监控

针对特定第三方库或中间件的监控，如 Druid 数据源监控，可以通过配置相应的库提供的监控扩展或适配器来实现。例如，Druid 提供了监控功能，可以在 Spring Boot 配置中启用，并通过 Actuator 端点或其他方式暴露监控数据。

综上所述，Spring Boot 应用监控涉及多个层面，从基础的健康检查、性能指标监控，到安全配置、日志审计，再到可视化管理工具集成和特定组件监控。通过合理利用 Spring Boot Actuator 及相关工具，可以构建一套全面且易用的应用监控体系。

基本示例

1. 添加依赖

在 Maven 项目中，你需要在 pom.xml 文件中加入 spring-boot-starter-actuator 依赖：

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

2. 配置端点暴露

默认情况下，Spring Boot 2.x 版本出于安全考虑不会暴露所有的 Actuator 端点。你可以通过 application.properties 或 application.yml 配置文件来控制哪些端点可以通过 HTTP 访问：

# 暴露所有端点
management.endpoints.web.exposure.include=*

# 或者仅暴露指定端点
management.endpoints.web.exposure.include=health,info,metrics

# 设置健康检查详情级别
management.endpoint.health.show-details=always

3. 使用端点示例

以下是一些访问不同端点的示例：

访问应用的基本信息：

GET http://localhost:8080/actuator/info

访问应用健康状况：

GET http://localhost:8080/actuator/health

访问应用的所有 metrics（度量指标）：

GET http://localhost:8080/actuator/metrics

获取应用中的所有 Bean 信息：

GET http://localhost:8080/actuator/beans

如果你启用了自定义的健康检查指示器，可以访问自定义的健康检查：

GET http://localhost:8080/actuator/health/<custom-check>

4. 自定义端点示例

如果你需要创建自定义的端点，可以定义一个实现 org.springframework.boot.actuate.endpoint.annotation.Endpoint 接口的类：

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;

@Endpoint(id = "myCustomEndpoint")
public class MyCustomEndpoint {

    @ReadOperation
    public String customData() {
        // 返回自定义的数据
        return "This is data from a custom endpoint";
    }
}

然后就可以通过 /actuator/myCustomEndpoint 访问这个自定义端点：

GET http://localhost:8080/actuator/myCustomEndpoint

请注意，以上示例假设你的 Spring Boot 应用正在运行并监听在 http://localhost:8080 端口上。

为了更好地管理和保护 Actuator 端点，还应该考虑添加安全相关的配置，尤其是在生产环境中。这通常涉及到 Spring Security 的配置，确保只有授权的用户或服务才能访问这些敏感的监控信息。