Spring Boot 揭秘与实战（九） 应用监控篇 - HTTP 健康监控

文章目录

1. 1. 内置 HealthIndicator 监控检测
2. 2. 自定义 HealthIndicator 监控检测
3. 3. 源代码

Health 信息是从 ApplicationContext 中所有的 HealthIndicator 的 Bean 中收集的， Spring Boot 内置了一些 HealthIndicator。

内置 HealthIndicator 监控检测

我们，来看下源代码清单。

可见，Spring Boot 帮忙我们集成了许多比较常见的健康监控，例如 MySQL、 MongoDB、 Redis、 ElasticSearch、 Solr、 RabbitMQ 等。

自定义 HealthIndicator 监控检测

一般情况下，Spring Boot 提供的健康监控无法满足我们复杂的业务场景，此时，我们就需要定制自己的 HealthIndicator， 扩展自己的业务监控。

我们，实现 HealthIndicator 接口创建一个简单的检测器类。它的作用很简单，只是进行服务状态监测。此时，通过重写 health() 方法来实现健康检查。

1. @Component
2. public class CusStatusHealthIndicator implements HealthIndicator {
3. @Override
4. public Health health() {
5. int errorCode = check();
6. if (errorCode != 0) {
7. return Health.down()
8. .withDetail("status", errorCode)
9. .withDetail("message", "服务故障")
10. .build();
11. }
12. return Health.up().build();
13. }
14. private int check(){
15. // 对监控对象的检测操作
16. return HttpStatus.NOT_FOUND.value();
17. }
18. }

我们，来看看打印结果。

1. {
2. "status": "DOWN",
3. "cusStatus": {
4. "status": 404,
5. "message": "服务故障"
6. }
7. }

此外，我们还可以通过继承 AbstractHealthIndicator 类，创建一个检测器类。

1. @Component
2. public class CusDiskSpaceHealthIndicator extends AbstractHealthIndicator {
3. private final FileStore fileStore;
4. private final long thresholdBytes;
5. @Autowired
6. public CusDiskSpaceHealthIndicator(
7. @Value("${health.filestore.path:/}") String path,
8. @Value("${health.filestore.threshold.bytes:10485760}") long thresholdBytes)
9. throws IOException {
10. fileStore = Files.getFileStore(Paths.get(path));
11. this.thresholdBytes = thresholdBytes;
12. }
13. @Override
14. protected void doHealthCheck(Health.Builder builder) throws Exception {
15. long diskFreeInBytes = fileStore.getUnallocatedSpace();
16. if (diskFreeInBytes >= thresholdBytes) {
17. builder.up();
18. } else {
19. builder.down();
20. }
21. long totalSpaceInBytes = fileStore.getTotalSpace();
22. builder.withDetail("disk.free", diskFreeInBytes);
23. builder.withDetail("disk.total", totalSpaceInBytes);
24. }
25. }

AbstractHealthIndicator 实现 HealthIndicator 接口，并重写了 health() 方法来实现健康检查。因此，我们只需要重写 doHealthCheck 方法即可。

一般情况下，我们不会直接实现 HealthIndicator 接口，而是继承 AbstractHealthIndicator 抽象类。因为，我们只需要重写 doHealthCheck 方法，并在这个方法中我们关注于具体的健康检测的业务逻辑服务。

我们，来看看打印结果。

1. {
2. "status": "UP",
3. "cusDiskSpace": {
4. "status": "UP",
5. "disk.free": 79479193600,
6. "disk.total": 104856547328
7. }
8. }

源代码

相关示例完整代码： springboot-action

(完)

如果觉得我的文章对你有帮助，请随意打赏。

• 版权声明：本文由 梁桂钊 发表于 梁桂钊的博客
• 转载声明：自由转载-非商用-非衍生-保持署名（创意共享3.0许可证），非商业转载请注明作者及出处，商业转载请联系作者本人。
• 文章标题：Spring Boot 揭秘与实战（九） 应用监控篇 - HTTP 健康监控
• 文章链接：http://blog.720ui.com/2017/springboot_09_actuator_http_healthindicator/