Spring Boot执行器-自定义健康endpoint

Question

我正在使用SpringBoot执行器返回应用程序的运行状况。

public class HealthMonitor implements HealthIndicator {

    @Override
    public Health health() {
        int errorCode = check();
        if (errorCode != 0) {
            return Health.down().withDetail("Error Code", errorCode).build();
        }
        return Health.up().build();
    }

    public int check() {
        return 0;
    }

}

我看到了下面的回复

{
  "status": "UP",
  "diskSpace": {
    "status": "UP",
    "free": 55020113920,
    "threshold": 10485760
  },
  "db": {
    "status": "UP",
    "database": "Oracle",
    "hello": "Hello"
  }
}

我想返回一个类似于下面的响应

{status: "Healthy"}

有办法做到吗？

Answer 1

Spring Boot及其健康指标具有很大的灵活性。

首先，根据您服务的复杂性，您可能不需要上面描述的HealthIndicator。开箱即用，Spring Boot将根据您的Spring配置返回“状态”。这包括数据库（SQL和一些noSQL）、邮件、JMS和其他。最新的Spring Boot文档第47.6.1节对此进行了描述

返回所需内容的最简单方法是在application.properties中设置一个属性：

endpoints.health.sensitive=true

这可能仅适用于Spring Boot的更高版本（1.4？）。

Answer 2

我认为您无法说服提供的Spring Boot健康终结点以完全不同的格式显示。

大多数Spring源代码都非常清晰，这也不例外。查看org.springframework.boot.actuate.endpoint.HealthEndpoint的源代码，您会发现它有一个返回Health的方法。您看到的JSON是Jackson对该对象的编组。

但是，您可以创建自己的endpoint，以与＜code＞HealthEndpoint，返回您自己喜欢的任何类。

您甚至可以将其委托给HealthEndpointbean：

 public MyHealthEndpoint(HealthEndpoint delegate) {
     this.delegate = delegate;
 }

 @Override
 public MyHealth invoke() {
      Health health = delegate.invoke();
      return new MyHealth(health.getStatus());
 }

Answer 3

要自定义您的状态消息，有一个名为：withDetail（）的方法。因此，当您编写返回Health.up（）.build（）;只需将其替换为

return Health.up().withDetail("My Application Status","Healthy")

所以这会给

{My Application Status: "Healthy"}