如何在春靴健康中添加自定义健康检查？

Question

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

这将为应用程序添加几个有用的endpoint。其中之一是/健康。当您启动应用程序并导航到/healthendpoint时，您将看到它已经返回了一些数据。

{
    "status":"UP",
    "diskSpace": {
        "status":"UP",
        "free":56443746,
        "threshold":1345660
    }
}

如何在春靴健康中添加自定义健康检查？

Answer 1

添加自定义健康检查很容易。只需创建一个新的Java类，从AbstractHealthIndicator扩展它，并实现doHealthCheck方法。方法获取通过一些有用方法传递的生成器。如果您的健康状况良好，请调用builder.up（）；如果不是，请调用builder.down（）。你做什么来检查健康完全取决于你。也许您想ping某个服务器或检查一些文件。

@Component
public class CustomHealthCheck extends AbstractHealthIndicator {
    @Override
    protected void doHealthCheck(Health.Builder bldr) throws Exception {
        // TODO implement some check
        boolean running = true;
        if (running) {
          bldr.up();
        } else {
          bldr.down();
        }
    }
}

这足以激活新的健康检查（确保@componentscan在您的应用程序上）。重新启动应用程序并将浏览器定位到/healthendpoint，您将看到新添加的健康检查。

{
    "status":"UP",
    "CustomHealthCheck": {
        "status":"UP"
    },
    "diskSpace": {
        "status":"UP",
        "free":56443746,
        "threshold":1345660
    }
}