好的，各位靓仔靓女们，欢迎来到今天的“Spring Boot Actuator：应用监控与管理”专场脱口秀！我是你们的老朋友，江湖人称“代码界郭德纲”，今天咱不聊相声，聊聊如何给你的Spring Boot应用装上千里眼和顺风耳，让它的一举一动都逃不过你的法眼。
先别害怕，Actuator听起来像终结者，其实它是个超级好用的工具，能让你轻松掌握应用的健康状况、性能指标、配置信息等等，堪称Spring Boot应用的“贴身管家”。 想象一下，你的应用就像一辆跑车，Actuator就是仪表盘，告诉你速度、油量、发动机温度，甚至还能检测胎压。有了它，你再也不用靠玄学Debug，而是靠数据说话，精准定位问题，让你的应用跑得更快、更稳！
一、Actuator：你是谁？从哪里来？要到哪里去？
好了，废话不多说，先来个正式的自我介绍。Spring Boot Actuator 是 Spring Boot 提供的一套生产级别的特性集合，用于监控和管理你的 Spring Boot 应用。它提供了一系列的 endpoints（端点），通过这些端点，你可以获取应用的各种信息，例如：
- 健康状况（Health）： 应用是否正常运行，依赖的服务是否可用。
- 信息（Info）： 应用的描述信息，版本号，构建时间等等。
- 指标（Metrics）： 应用的性能指标，例如 JVM 内存使用情况，HTTP 请求次数，数据库连接池状态等等。
- 日志（Logs）： 查看和配置应用的日志级别。
- 审计（Auditing）： 记录用户的操作，例如登录、修改配置等等。
- HTTP Tracing: 查看HTTP请求的详细信息，例如请求头、响应头、请求时间等等。
简单来说，Actuator 就是一个“全能管家”，帮你监控、管理、诊断你的 Spring Boot 应用。
二、快速上手：三步搞定，So Easy！
说了这么多，是不是有点迫不及待想试试了？别急，Actuator 的使用非常简单，只需要三步：
-
引入依赖： 在你的
pom.xml文件中添加 Actuator 的依赖：<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> -
配置管理端口： 在
application.properties或application.yml文件中配置 Actuator 的管理端口。建议不要和你的应用端口使用同一个端口，以免发生冲突。management.server.port=8081 -
访问 Endpoints： 启动你的 Spring Boot 应用，然后在浏览器或使用 curl 命令访问 Actuator 提供的 endpoints。默认情况下，Actuator 的 endpoints 是受保护的，需要进行身份验证。你可以通过配置
management.endpoints.web.exposure.include=*来暴露所有的 endpoints。注意：在生产环境中，强烈建议不要暴露所有的 endpoints，应该只暴露必要的 endpoints，并进行身份验证。例如，访问健康状况的 endpoint：
curl http://localhost:8081/actuator/health如果你的应用正常运行，你会看到类似这样的 JSON 响应：
{ "status": "UP" }是不是很简单？就像泡方便面一样简单！🍜
三、Actuator Endpoints：十八般武艺，样样精通！
Actuator 提供了很多 endpoints，每个 endpoint 都有不同的功能。下面我们来详细介绍一些常用的 endpoints：
| Endpoint | 描述 |
|---|---|
/actuator/health |
显示应用的健康状况。可以显示应用的整体健康状况，也可以显示各个组件的健康状况，例如数据库连接、消息队列等等。 |
/actuator/info |
显示应用的描述信息。可以显示应用的名称、版本号、构建时间等等。你可以在 application.properties 或 application.yml 文件中配置这些信息。 |
/actuator/metrics |
显示应用的性能指标。可以显示 JVM 内存使用情况、HTTP 请求次数、数据库连接池状态等等。Actuator 使用 Micrometer 来收集应用的性能指标。 |
/actuator/loggers |
查看和配置应用的日志级别。你可以动态地修改应用的日志级别，而不需要重启应用。 |
/actuator/auditevents |
显示应用的审计事件。可以显示用户的登录、修改配置等等操作。 |
/actuator/httptrace |
显示 HTTP 请求的详细信息。可以显示请求头、响应头、请求时间等等。 |
/actuator/env |
显示应用的配置信息。可以显示环境变量、系统属性、application.properties 中的配置等等。注意：这个 endpoint 可能会暴露敏感信息，例如数据库密码，请谨慎使用。 |
/actuator/beans |
显示应用中所有的 Spring Beans。 |
/actuator/mappings |
显示应用中所有的请求映射。可以查看哪些 URL 对应哪些 Controller 方法。 |
/actuator/scheduledtasks |
显示应用中所有的定时任务。 |
/actuator/threaddump |
显示应用的线程转储。可以查看应用的线程状态，例如哪些线程在运行，哪些线程在等待。 |
/actuator/heapdump |
生成应用的堆转储文件。堆转储文件包含了应用在某个时刻的内存快照，可以用于分析内存泄漏问题。注意：生成堆转储文件会消耗大量的资源，请谨慎使用。 |
/actuator/configprops |
显示应用中所有的配置属性。 |
/actuator/caches |
显示应用中所有的缓存信息。 |
/actuator/liquibase |
如果你使用了 Liquibase 来管理数据库，这个 endpoint 可以显示 Liquibase 的信息，例如数据库的变更历史。 |
/actuator/flyway |
如果你使用了 Flyway 来管理数据库，这个 endpoint 可以显示 Flyway 的信息，例如数据库的迁移历史。 |
这些 endpoints 就像一个个“侦察兵”，帮你收集应用的各种情报。你可以根据自己的需求选择合适的 endpoints 来使用。
四、定制你的 Actuator：打造专属的“贴身管家”
Actuator 默认提供的 endpoints 已经很强大了，但有时候你可能需要定制 Actuator，例如：
- 添加自定义的健康检查： 你可能需要检查一些特定的服务是否可用，例如 Redis、Kafka 等等。
- 添加自定义的指标： 你可能需要收集一些特定的业务指标，例如用户注册数量、订单数量等等。
- 修改 endpoints 的访问路径： 你可能需要修改 endpoints 的访问路径，使其更加安全。
别担心，Actuator 提供了强大的定制能力，让你打造专属的“贴身管家”。
1. 添加自定义的健康检查
你可以通过实现 HealthIndicator 接口来添加自定义的健康检查。例如，你可以创建一个 RedisHealthIndicator 类来检查 Redis 是否可用：
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;
import redis.clients.jedis.Jedis;
@Component
public class RedisHealthIndicator implements HealthIndicator {
@Override
public Health health() {
try {
Jedis jedis = new Jedis("localhost", 6379); // 替换为你的 Redis 地址
jedis.ping();
return Health.up().withDetail("message", "Redis is up!").build();
} catch (Exception e) {
return Health.down().withDetail("error", e.getMessage()).build();
}
}
}在这个例子中，我们使用 Jedis 客户端来连接 Redis，如果连接成功，就返回 Health.up()，否则返回 Health.down()。然后，在 /actuator/health endpoint 中，你就可以看到 Redis 的健康状况了。
2. 添加自定义的指标
你可以使用 Micrometer 来添加自定义的指标。Micrometer 是一个度量工具库，可以让你方便地收集应用的性能指标。
例如，你可以创建一个 UserRegistrationCounter 类来统计用户注册数量：
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import org.springframework.stereotype.Component;
@Component
public class UserRegistrationCounter {
private final Counter counter;
public UserRegistrationCounter(MeterRegistry meterRegistry) {
this.counter = meterRegistry.counter("user.registration.count");
}
public void increment() {
counter.increment();
}
}在这个例子中，我们使用 MeterRegistry 来创建一个名为 user.registration.count 的 Counter，每次有用户注册时，就调用 increment() 方法来增加计数。然后，在 /actuator/metrics endpoint 中，你就可以看到 user.registration.count 指标了。
3. 修改 endpoints 的访问路径
你可以在 application.properties 或 application.yml 文件中配置 Actuator 的访问路径。例如，你可以将 /actuator 修改为 /manage：
management.endpoints.web.base-path=/manage这样，你就可以通过 /manage/health 来访问健康状况的 endpoint 了。
五、安全加固：保护你的“情报中心”
Actuator 暴露了应用的很多敏感信息，因此需要进行安全加固，防止未经授权的访问。
1. 使用 Spring Security 进行身份验证
最常用的方法是使用 Spring Security 进行身份验证。你可以添加 Spring Security 的依赖，并配置用户名和密码：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>spring.security.user.name=admin
spring.security.user.password=password
management.endpoints.web.exposure.include=health,info,metrics在这个例子中，我们配置了用户名和密码为 admin 和 password。然后，我们只暴露了 health、info 和 metrics 这三个 endpoints。
2. 使用 IP 白名单进行访问控制
你也可以使用 IP 白名单进行访问控制，只允许特定的 IP 地址访问 Actuator endpoints。
management.endpoints.web.exposure.include=health,info,metrics
management.endpoint.health.roles=ACTUATOR
management.endpoint.info.roles=ACTUATOR
management.endpoint.metrics.roles=ACTUATOR
management.server.address=127.0.0.1在这个例子中，我们只允许本地访问 Actuator endpoints，并且需要拥有 ACTUATOR 角色才能访问。
3. 使用防火墙进行访问控制
你还可以使用防火墙进行访问控制，只允许特定的 IP 地址和端口访问 Actuator endpoints。
六、总结：Actuator，你的应用守护神！
好了，今天的“Spring Boot Actuator：应用监控与管理”专场脱口秀就到这里了。希望通过今天的讲解，大家对 Actuator 有了更深入的了解。Actuator 是 Spring Boot 应用的“贴身管家”，可以帮你监控、管理、诊断你的应用，让你轻松掌握应用的健康状况、性能指标、配置信息等等。记住，有了 Actuator，你再也不用靠玄学 Debug，而是靠数据说话，精准定位问题，让你的应用跑得更快、更稳！
最后，送给大家一句话：工欲善其事，必先利其器！ 掌握 Actuator，让你的 Spring Boot 应用更上一层楼！🚀
感谢大家的观看，下次再见！👋