概述
在使用 Spring Boot 进行开发和部署应用程序时，Actuator 是一个非常有用的功能。Actuator 提供了对应用程序的监控和管理功能，通过使用 Actuator，我们可以快速了解应用程序的运行状态、性能指标和健康状况。本文将详细介绍如何配置 Actuator，并展示一些常用的端点和扩展功能。
添加 Actuator 依赖
首先，我们需要在 pom.xml 文件中添加 Actuator 的依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
添加完依赖后，重新构建项目以使更改生效。
配置 Actuator
在默认情况下，Actuator 端点是启用的，并且可以通过 /actuator 路径访问。我们可以通过 application.properties 或 application.yml 文件配置 Actuator 的端点和提供的功能。
以下是一些常用的配置示例：
management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always
management.endpoint.info.enabled=true
management.endpoint.metrics.enabled=true
management.metrics.export.statsd.enabled=true
在这里，我们开启了所有的 Actuator 端点，并显示了健康端点的详细信息。我们还打开了信息和指标端点，以及将指标导出到 StatsD。
Actuator 端点
Actuator 提供了多个端点，用于获取应用程序的信息和指标。一些常用的端点包括：
/actuator/health：显示应用程序的健康状况。/actuator/info：显示应用程序的自定义信息。/actuator/metrics：显示应用程序的指标信息。/actuator/mappings：显示应用程序的 URL 映射信息。/actuator/env：显示应用程序的环境变量。/actuator/loggers：显示应用程序的日志配置。
Actuator 扩展功能
除了默认的端点，我们还可以自定义和扩展 Actuator，以满足特定需求。
自定义健康检查
我们可以自定义健康检查，通过实现 HealthIndicator 接口，编写自定义的健康检查逻辑。
@Component
public class CustomHealthIndicator implements HealthIndicator {
@Override
public Health health() {
int errorCode = check(); // 自定义的健康检查逻辑
if (errorCode != 0) {
return Health.down().withDetail("Error Code", errorCode).build();
}
return Health.up().build();
}
private int check() {
// 健康检查逻辑
return 0; // 正常返回 0
}
}
自定义信息端点
我们可以自定义信息端点，通过实现 InfoContributor 接口，编写自定义的信息生成逻辑。
@Component
public class CustomInfoContributor implements InfoContributor {
@Override
public void contribute(Info.Builder builder) {
Map<String, Object> customInfo = new HashMap<>();
customInfo.put("key1", "value1");
customInfo.put("key2", "value2");
builder.withDetails(customInfo);
}
}
自定义指标
我们可以自定义指标，通过实现 PublicMetrics 接口，编写自定义的指标生成逻辑。
@Component
public class CustomMetrics implements PublicMetrics {
@Override
public Collection<Metric<?>> metrics() {
List<Metric<?>> metrics = new ArrayList<>();
metrics.add(new Metric<>("custom.metric", 123));
return metrics;
}
}
结论
通过配置和使用 Actuator，我们可以方便地监控和管理 Spring Boot 应用程序。本文介绍了如何配置 Actuator，并展示了一些常用的端点和扩展功能。希望这篇博客能帮助你更好地理解和使用 Actuator。
本文来自极简博客，作者：技术解码器，转载请注明原文链接：Spring Boot - 配置 Actuator
