如何使`@endpoint(id=“health”）`在Spring Boot2.0中工作？

Question

@Endpoint(id = "health")
public class HealthEndpoint {
    @ReadOperation
    public Health health() {
        return new Health.Builder()
            .up()
            .withDetail("MyStatus", "is happy")
            .build();
    }
}

当我使用通过healthindicator实现自定义健康信息的“传统方式”时，它会按照预期工作，健康信息会被给定的细节修饰：

@Component
public class MyHealthIndicator implements HealthIndicator {
    @Override
    public Health health() {
        return new Health.Builder()
            .up()
            .withDetail("MyStatus 1.1", "is happy")
            .withDetail("MyStatus 1.2", "is also happy")
            .build();
    }
}

问题：要使@endpoint(id=“health”）解决方案工作，还需要配置和/或实现哪些功能？

我的意图不是创建自定义执行器myhealt，而是自定义现有的healt执行器。基于这些文档，我希望达到与实现HealthIndicator相同的结果。我的假设错了吗？

Maven配置pom.xml包含：

xml prettyprint-override"><parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.0.M5</version>
    <relativePath/>
</parent>

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

Spring Boot配置application.properties包含：

endpoints.health.enabled=true
endpoints.autoconfig.enabled=true
endpoints.autoconfig.web.enabled=true

Answer 1

>

关于新的Spring执行器endpoint的文档不是很清楚。它试图以现有的健康endpoint为例解释新的endpoint基础结构。

新的endpointID必须是唯一的，并且不应该与现有的执行器endpoint相同。如果试图将以下示例的ID更改为healt，则会出现以下异常：

 java.lang.IllegalStateException: Found two endpoints with the id 'health'

上面关于使用@bean注释声明endpoint类的注释是正确的。

自定义healtendpoint在Spring Boot2.0中没有更改。您仍然必须实现healthindicator来添加自定义值。

以下是在Spring Boot2.0中创建自定义执行器endpoint所需的更改。

包含自定义信息的域。

@Data
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class MyHealth {

    private Map<String, Object> details;

    @JsonAnyGetter
    public Map<String, Object> getDetails() {
        return this.details;
    }
}

@Endpoint(id = "myhealth")
public class MyHealthEndpoint {

    @ReadOperation
    public MyHealth health() {
        Map<String, Object> details = new LinkedHashMap<>();
        details.put("MyStatus", "is happy");
        MyHealth health = new MyHealth();
        health.setDetails(details);

        return health;
    }
}

@WebEndpointExtension(endpoint = MyHealthEndpoint.class)
public class MyHealthWebEndpointExtension {

    private final MyHealthEndpoint delegate;

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

    @ReadOperation
    public WebEndpointResponse<MyHealth> getHealth() {
        MyHealth health = delegate.health();
        return new WebEndpointResponse<>(health, 200);
    }
}

@Configuration
public class ActuatorConfiguration {

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnEnabledEndpoint
    public MyHealthEndpoint myHealthEndpoint() {
        return new MyHealthEndpoint();
    }

    @Bean
    @ConditionalOnMissingBean
    @ConditionalOnEnabledEndpoint
    @ConditionalOnBean({MyHealthEndpoint.class})
    public MyHealthWebEndpointExtension myHealthWebEndpointExtension(
            MyHealthEndpoint delegate) {
        return new MyHealthWebEndpointExtension(delegate);
    }
}

更改application.yml,

endpoints:
  myhealth:
    enabled: true

启动应用程序后，应该能够访问http:// : /application/myhealth 上的新执行器endpoint。

您应该会得到如下所示的响应,

{
  "MyStatus": "is happy"
}