Spring Boot与Actuator监控：构建实时监控与健康管理，提升应用性能与稳定性！-CFANZ编程社区

🏆本文收录于「滚雪球学SpringBoot」专栏，手把手带你零基础入门springboot，从入门到就业，助你早日登顶实现财富自由🚀；同时，欢迎大家关注&&收藏&&订阅！持续更新中，up！up！up！！

环境说明：Windows 10 + IntelliJ IDEA 2021.3.2 + Jdk 1.8

前言：应用监控的重要性与挑战

在现代软件开发中，随着应用架构的复杂性增加，如何有效地监控和管理应用变得尤为重要。应用的健康状态、性能监控、日志分析等都成为运维和开发人员日常工作的一部分。Spring Boot作为目前流行的Java开发框架，其提供了Spring Boot Actuator这个强大的工具，使得我们能够方便地获取应用的健康状态、性能指标、系统日志等关键信息，帮助我们实时监控和管理生产环境中的应用。

本文将深入探讨Spring Boot Actuator的各项功能，如何启用和配置Actuator端点，如何自定义健康检查与监控指标，如何保证Actuator端点的安全性，并且介绍如何与流行的监控工具（如Prometheus、Grafana）进行集成。通过这些功能，你将能够在Spring Boot应用中实现全面的监控和管理，提升应用的可靠性与稳定性！📊

一、Spring Boot Actuator概述

1.1 什么是Spring Boot Actuator？

Spring Boot Actuator是Spring Boot的一个子项目，它为Spring Boot应用提供了生产级的特性。Actuator提供了众多端点，帮助开发者和运维人员监控应用的健康状况、性能、系统指标等。Actuator的核心特性包括：

健康检查：检查应用及其依赖项的健康状态，如数据库连接、消息队列等。
度量与指标：获取应用的各种性能指标，如JVM的内存使用情况、HTTP请求统计等。
应用信息：提供应用的元数据，如版本号、构建时间、环境信息等。
日志管理：动态调整应用日志级别，支持实时的日志监控。
自定义端点：开发者可以根据需求创建自定义的Actuator端点来暴露应用的特定信息。

1.2 为什么使用Spring Boot Actuator？

实时监控：Actuator可以帮助我们实时了解应用的健康状况，及时发现潜在问题。
性能分析：通过Actuator获取JVM和应用的性能指标，帮助开发者进行性能优化。
自动化运维：Actuator提供了多种监控端点，能方便地与自动化运维工具（如Prometheus、Grafana）集成，进行数据的采集与展示。
易于集成：Actuator与Spring Boot生态系统的其他工具无缝集成，开箱即用。

二、开启和配置Actuator端点

2.1 启用Spring Boot Actuator

要启用Spring Boot Actuator，首先需要在pom.xml文件中添加Actuator的依赖。Spring Boot的Actuator功能由spring-boot-starter-actuator提供。

2.1.1 添加依赖

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

添加这个依赖后，Spring Boot应用将自动启用Actuator，并暴露出一组默认的端点（如/actuator/health、/actuator/metrics等）。

2.2 配置Actuator端点

Spring Boot Actuator提供了多个端点，默认情况下，只有部分端点是启用的（如health、info）。你可以通过application.properties或application.yml配置文件来启用、禁用或配置这些端点。

2.2.1 配置启用的端点

# 启用所有端点
management.endpoints.web.exposure.include=*

# 启用特定端点
management.endpoints.web.exposure.include=health,info,metrics

2.2.2 配置Actuator端点的路径

默认情况下，Actuator端点的路径是/actuator/{endpoint}，你可以修改它的路径前缀，甚至修改单个端点的路径。

management.endpoint.health.show-details=always
management.endpoints.web.base-path=/manage

在这个配置中，所有Actuator端点的路径将以/manage为前缀，health端点将返回详细的健康信息。

2.2.3 禁用不需要的端点

为了安全性和性能考虑，某些端点（如shutdown）默认是禁用的。你可以选择禁用一些不必要的端点：

management.endpoints.web.exposure.exclude=shutdown

三、自定义健康检查与指标

3.1 自定义健康检查

健康检查是Spring Boot Actuator的核心功能之一，Actuator提供了对各种系统组件（如数据库、消息队列、缓存）的健康检查。如果默认的健康检查不符合你的需求，你还可以自定义健康检查逻辑。

3.1.1 实现自定义健康检查

通过实现HealthIndicator接口，你可以创建自定义的健康检查逻辑。例如，我们可以创建一个检查第三方服务健康状况的健康检查。

@Component
public class ThirdPartyServiceHealthIndicator implements HealthIndicator {

    @Override
    public Health health() {
        boolean isServiceUp = checkThirdPartyService(); // 自定义检查逻辑
        if (isServiceUp) {
            return Health.up().withDetail("Service", "Up").build();
        } else {
            return Health.down().withDetail("Service", "Down").build();
        }
    }

    private boolean checkThirdPartyService() {
        // 这里可以放置调用外部API、数据库等的逻辑
        return true;  // 假设服务正常
    }
}

在这个例子中，我们实现了HealthIndicator接口，创建了一个检查第三方服务健康的自定义健康检查。

3.1.2 查看自定义健康检查

自定义的健康检查将自动集成到Spring Boot Actuator的健康端点。访问/actuator/health时，你可以看到自定义健康检查的结果。

{
  "status": "UP",
  "details": {
    "Service": "Up"
  }
}

3.2 自定义指标

Spring Boot Actuator还支持自定义的应用指标，帮助开发者监控应用的各种自定义数据（如请求响应时间、应用业务数据等）。

3.2.1 实现自定义指标

你可以通过MeterRegistry来注册自定义指标。以下是一个示例，展示了如何创建一个自定义的计数器（Counter）指标。

@Component
public class CustomMetrics {

    private final Counter customCounter;

    public CustomMetrics(MeterRegistry meterRegistry) {
        this.customCounter = Counter.builder("custom_counter")
            .description("Custom counter metric")
            .tags("environment", "production")
            .register(meterRegistry);
    }

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

在这个例子中，我们通过MeterRegistry注册了一个自定义的计数器指标，每次调用incrementCounter方法时，计数器都会增加。

3.2.2 查看自定义指标

自定义的指标将显示在/actuator/metrics端点中。例如，你可以访问/actuator/metrics/custom_counter来查看计数器的值。

{
  "name": "custom_counter",
  "description": "Custom counter metric",
  "measurements": [
    {
      "statistic": "COUNT",
      "value": 10.0
    }
  ],
  "availableTags": [
    {
      "tag": "environment",
      "values": ["production"]
    }
  ]
}

四、安全性配置与保护Actuator端点

4.1 默认的安全性

默认情况下，Spring Boot Actuator的部分端点（如/actuator/health、/actuator/metrics等）是公开的，这可能导致敏感信息泄露。为了确保应用的安全性，我们需要为Actuator端点配置适当的安全策略。

4.1.1 配置端点的访问控制

Spring Boot Actuator可以与Spring Security集成，通过配置HTTP安全策略来保护Actuator端点。例如，你可以限制访问/actuator/health端点的权限。

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

4.1.2 配置端点的认证

你可以配置Spring Security来对Actuator端点进行身份验证。例如，限制只有管理员可以访问健康检查和系统指标。

@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
            .antMatchers("/actuator/health").hasRole("ADMIN")
            .antMatchers("/actuator/metrics").hasRole("ADMIN")
            .anyRequest().authenticated()
            .and()
            .httpBasic();  // 开启基本认证
    }
}

在这个配置中，/actuator/health和/actuator/metrics端点仅允许拥有ADMIN角色的用户访问。

五、Spring Boot Actuator与监控工具集成（Prometheus、Grafana等）

5.1 与Prometheus集成

Prometheus是一个开源的监控系统，广泛用于收集和存储应用的时间序列数据。Spring Boot Actuator与Prometheus集成，可以通过/actuator/prometheus端点导出应用的度量数据。

5.1.1 启用Prometheus端点

在application.properties中启用Prometheus端点：

management.endpoints.web.exposure.include=prometheus

然后，Prometheus会通过/actuator/prometheus端点抓取应用的度量数据。

5.2 与Grafana集成

Grafana是一个开源的数据可视化工具，通常与Prometheus配合使用，帮助开发者和运维人员创建实时监控面板。

5.2.1 配置Grafana

Grafana可以通过连接Prometheus作为数据源，来展示Spring Boot Actuator暴露的度量指标。通过Grafana的Web界面，你可以创建面板，展示应用的健康状况、响应时间、请求数量等关键指标。

总结：全方位监控，保障应用稳定性与健康

通过本文的深入学习，你已经掌握了如何使用Spring Boot Actuator来监控和管理应用。我们介绍了如何开启和配置Actuator端点，如何自定义健康检查与指标，如何保护Actuator端点的安全性，以及如何与Prometheus和Grafana等监控工具进行集成。

Spring Boot Actuator为我们的应用提供了强大的生产级监控和管理能力，使得我们能够实时监控应用的状态，及时发现问题并做出响应。希望这篇文章能够帮助你构建更健康、更高效、更稳定的Spring Boot应用！📊

🧧福利赠与你🧧

无论你是计算机专业的学生，还是对编程有兴趣的小伙伴，都建议直接毫无顾忌的学习此专栏「滚雪球学SpringBoot」，bug菌郑重承诺，凡是学习此专栏的同学，均能获取到所需的知识和技能，全网最快速入门SpringBoot，就像滚雪球一样，越滚越大，无边无际，指数级提升。

最后，如果这篇文章对你有所帮助，帮忙给作者来个一键三连，关注、点赞、收藏，您的支持就是我坚持写作最大的动力。

✨️ Who am I?

我是bug菌，CSDN | 掘金 | InfoQ | 51CTO | 华为云 | 阿里云 | 腾讯云等社区博客专家，C站博客之星Top30，华为云2023年度十佳博主，掘金多年度人气作者Top40，掘金等各大社区平台签约作者，51CTO年度博主Top12，掘金/InfoQ/51CTO等社区优质创作者；全网粉丝合计 30w+；更多精彩福利点击[这里]；硬核微信公众号[「猿圈奇妙屋」]，欢迎你的加入！免费白嫖最新BAT互联网公司面试真题、4000G PDF电子书籍、简历模板等海量资料，你想要的我都有，关键是你不来拿。

-End-