SpringBoot监控利器：Actuator端点配置与自定义指标

🎓博主介绍：Java、Python、js全栈开发 “多面手”，精通多种编程语言和技术，痴迷于人工智能领域。秉持着对技术的热爱与执着，持续探索创新，愿在此分享交流和学习，与大家共进步。
📖DeepSeek-行业融合之万象视界(附实战案例详解100+)
📖全栈开发环境搭建运行攻略：多语言一站式指南(环境搭建+运行+调试+发布+保姆级详解)
👉感兴趣的可以先收藏起来，希望帮助更多的人

SpringBoot监控利器：Actuator端点配置与自定义指标

一、引言

在现代的软件开发中，Spring Boot 凭借其快速开发、简化配置等特性，成为了构建微服务和 Web 应用的热门框架。然而，在应用部署到生产环境后，对应用的监控和管理就变得尤为重要。Spring Boot Actuator 正是为解决这一问题而生，它提供了一系列的端点（Endpoints），用于监控应用的运行状态、性能指标等信息。本文将详细介绍 Spring Boot Actuator 的端点配置以及如何自定义指标，帮助技术人员更好地监控和管理 Spring Boot 应用。

二、Spring Boot Actuator 简介

2.1 Actuator 是什么

Spring Boot Actuator 是 Spring Boot 提供的一个强大的监控和管理工具集。它通过暴露一系列的端点，让开发者可以方便地获取应用的运行时信息，如健康状态、内存使用情况、线程信息等。这些端点可以通过 HTTP 或 JMX 进行访问，方便开发者进行远程监控和管理。

2.2 Actuator 的作用

• 监控应用状态：通过健康检查端点可以实时了解应用的运行状态，判断应用是否正常工作。
• 性能监控：获取应用的性能指标，如内存使用、CPU 使用率、线程池状态等，帮助开发者及时发现性能瓶颈。
• 日志管理：动态调整日志级别，方便在不重启应用的情况下进行日志调试。
• 配置管理：查看和修改应用的配置属性，实现动态配置更新。

三、Actuator 端点配置

3.1 添加依赖

要使用 Spring Boot Actuator，首先需要在项目的 pom.xml（如果是 Maven 项目）中添加以下依赖：

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

如果是 Gradle 项目，则在 build.gradle 中添加：

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

3.2 配置端点

Actuator 端点默认只暴露了 /actuator/health 和 /actuator/info 两个端点。要暴露更多的端点，可以在 application.properties 或 application.yml 中进行配置。

3.2.1 使用 application.properties 配置

# 暴露所有端点
management.endpoints.web.exposure.include=*
# 排除某些端点
management.endpoints.web.exposure.exclude=env,beans

3.2.2 使用 application.yml 配置

management:
  endpoints:
    web:
      exposure:
        include: '*'
        exclude: 'env,beans'

3.3 常见端点介绍

• /actuator/health：用于检查应用的健康状态，返回应用的整体健康信息，如是否正常运行、数据库连接是否正常等。
• /actuator/info：用于显示应用的自定义信息，可以通过配置 info.* 属性来添加自定义信息。

info.app.name=My Spring Boot Application
info.app.version=1.0.0

• /actuator/metrics：用于显示应用的各种性能指标，如系统内存使用、CPU 使用率、HTTP 请求统计等。
• /actuator/env：用于显示应用的环境信息，包括系统属性、环境变量、配置属性等。
• /actuator/loggers：用于管理和查看应用的日志配置，可以动态调整日志级别。

四、自定义 Actuator 端点

4.1 创建自定义端点

可以通过实现 Endpoint 接口或使用 @Endpoint 注解来创建自定义端点。以下是一个使用 @Endpoint 注解创建自定义端点的示例：

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

import java.util.HashMap;
import java.util.Map;

@Component
@Endpoint(id = "custom")
public class CustomEndpoint {

    @ReadOperation
    public Map<String, String> customInfo() {
        Map<String, String> info = new HashMap<>();
        info.put("message", "This is a custom endpoint");
        info.put("author", "John Doe");
        return info;
    }
}

在上述示例中，我们创建了一个名为 custom 的自定义端点，通过 @ReadOperation 注解定义了一个只读操作，返回一个包含自定义信息的 Map。

4.2 访问自定义端点

配置好自定义端点后，可以通过以下 URL 访问：

http://localhost:8080/actuator/custom

返回结果如下：

{
    "message": "This is a custom endpoint",
    "author": "John Doe"
}

五、自定义指标

5.1 引入 Micrometer 依赖

Micrometer 是 Spring Boot Actuator 用于指标收集的核心库，要使用自定义指标，需要在项目中添加 Micrometer 依赖：

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-core</artifactId>
</dependency>

5.2 创建自定义指标

可以通过 MeterRegistry 来创建和管理自定义指标。以下是一个简单的示例：

import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;

@Component
public class CustomMetrics {

    private final MeterRegistry meterRegistry;
    private Counter customCounter;

    public CustomMetrics(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;
    }

    @PostConstruct
    public void init() {
        customCounter = meterRegistry.counter("custom.counter");
    }

    public void incrementCounter() {
        customCounter.increment();
    }
}

在上述示例中，我们创建了一个名为 custom.counter 的计数器指标，并提供了一个方法用于增加计数器的值。

5.3 监控自定义指标

可以通过 /actuator/metrics 端点来查看自定义指标的值：

http://localhost:8080/actuator/metrics/custom.counter

返回结果如下：

{
    "name": "custom.counter",
    "description": null,
    "baseUnit": null,
    "measurements": [
        {
            "statistic": "COUNT",
            "value": 10.0
        }
    ],
    "availableTags": []
}

六、总结

Spring Boot Actuator 为开发者提供了强大的监控和管理功能，通过配置和使用 Actuator 端点，可以方便地获取应用的运行时信息。同时，通过自定义端点和指标，可以根据应用的实际需求进行个性化的监控和管理。希望本文能够帮助技术人员更好地使用 Spring Boot Actuator 来监控和管理 Spring Boot 应用。