从内部获取Spring Boot运行状况的正确方法

时间:2020-08-20 17:48:29

标签: spring spring-boot spring-boot-actuator

我有一个外部要求,即我提供一个端点来告诉负载平衡器将流量发送到我的应用程序。与Kubernetes的“就绪”探针非常相似,但是它必须是特定的格式和路径,因此我可以给他们提供执行器健康状况的终点。

过去,我曾使用HealthEndpoint并称为health(),但这不适用于响应式应用程序。有没有更灵活的方法来查看应用程序是否“启动”?在这个级别上,我不在乎它是响应式还是servlet,我只想知道Spring Boot对应用程序的评价。

我还没有找到类似的东西,大多数文章都谈论调用/actuator/health,但这不是我所需要的。


编辑:

稍微详细一点,如果好的话,我必须返回某个字符串“ NS_ENABLE”。在某些情况下,我会返回“ NS_DISABLE”,因此我不能不返回任何东西,这通常是合理的。

此外,我真的很喜欢Spring Boot为我进行检查的方式。我不想重新执行所有这些检查。


编辑2:我的最终解决方案

即使这不是我的最终解决方案,下面的答案也使我走得很远,所以我想提示我的最终理解。

事实证明,HealthEndpoint与Servlet应用程序一样适用于反应式应用程序,只需将它们包装在Mono中。

3 个答案:

答案 0 :(得分:1)

简单的解决方案是编写自己的运行状况终结点,而不是依赖Spring。 Spring Boot为您提供了可用于生产的端点,但是如果不满足您的目的,请编写您的端点。它将仅返回“ UP”作为响应。如果服务关闭,它将不会返回任何内容。

答案 1 :(得分:0)

我们如何定义任何Web服务器的运行状况? 我们查看依赖服务的状态,检查Redis,MySQL,MongoDB,ElasticSearch和其他数据库的状态,这是执行器在内部执行的操作。

执行器检查不同数据库的状态,并根据该状态返回“上/下”。

您可以实现自己的方法来检查依赖服务的运行状况。

  • 可以使用ping命令检查Redis是否健康
  • 可以使用SELECT 1命令验证MySQL或运行某些应该总是成功的查询,例如SHOW TABLES

同样,您可以对其他服务实施运行状况检查。如果您发现所有必需的服务都已启动,则可以声明为已启动,否则为已关闭。

关闭触发器如何处理?无论您的依存服务处于什么状态,无论何时服务器收到关闭信号,都应始终关闭,这样上游不会向该实例发送呼叫。


修改

可以通过自动连接执行器模块中的一个或多个bean,以编程方式检查整个spring应用程序的运行状况。

@Controller
public class MyHealthController{
 @Autowired private HealthEndpoint healthEndpoint;
 @GetMapping("health")
  public Health health() {
    Health health = healthEndpoint.health();
    return healthEndpoint.health();
  }
}

还有其他与运行状况检查有关的bean,我们可以自动为所需的bean连接电线。一些bean提供了各个组件的运行状况,我们可以使用HealthAggregator组合每个组件的运行状况以获取最终的运行状况。可以通过HealthIndicatorRegistry访问所有已注册的健康指标组件。

@Controller
public class MyHealthController{
  @Autowired private HealthAggregator healthAggregator;
  @Autowired private HealthIndicatorRegistry healthIndicatorRegistry;

  @GetMapping("health")
  public Health health() {
    Map<String, Health> health = new HashMap<>();
    for (Entry<String, HealthIndicator> entry : healthIndicatorRegistry.getAll().entrySet()) {
      health.put(entry.getKey(), entry.getValue().health());
    }
    return healthAggregator.aggregate(health);
  }
}

  

注意:反应组件具有其自己的运行状况指示器。有用的类是ReactiveHealthIndicatorRegistryReactiveHealthIndicator

答案 2 :(得分:0)

这是有关编写反应式健康端点的spring boot文档。按照指南进行操作,应该足以满足您的用例。

他们还记录了如何编写应用程序的liveliness and Readiness

https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#reactive-health-indicators