Spring Boot Liveness 和 Readness 接口使用

在 Spring Boot 2.3+ 中，提供了单独的 liveness 和 readness，用于为 Kubernetes 提供相应检查接口

liveness
用于检查应用是否存活，当应用组件因故障不健康时，可以通过这个接口的结果，配置相应策略，重启应用或重新调度 Pod
readness
用于检查应用是否就绪，是否可以提供服务，如当流量太大超过应用的承载范围时，可以将这个接口的状态改为不健康，这样可以停止接收流量，当处理完后再次检查时变为健康，继续处理请求

配置

build.gradle 添加依赖

plugins {id 'org.springframework.boot' version '2.3.2.RELEASE'id 'io.spring.dependency-management' version '1.0.9.RELEASE'id 'java'
}
dependencies {implementation 'org.springframework.boot:spring-boot-starter-actuator'implementation 'org.springframework.boot:spring-boot-starter-web'
}

application.properties 添加配置

从 2.3.2 开始，/actuator/health 接口添加了分组的概念，默认分为 liveness 和 readness 两个组，需要显式指定后才可以使用，否则会返回 404；/actuator/health 接口包含所有的指标

当前应用支持的指标，可以设置 management.endpoint.health.show-details=always后从 /actuator/health 接口获取

先指定 readness 指标，之后可以将剩余的所有指标设置为 liveness 的指标

management.endpoint.health.show-details=always
management.endpoint.health.group.readiness.include=ping
management.endpoint.health.group.liveness.include=*
management.endpoint.health.group.liveness.exclude=${management.endpoint.health.group.readiness.include}

测试

启动应用

请求相应的接口

health

curl http://localhost:8080/actuator/health

{"status": "UP","components": {"diskSpace": {"status": "UP","details": {"total": 499963174912,"free": 380364800000,"threshold": 10485760,"exists": true}},"livenessStateProbeIndicator": {"status": "UP"},"ping": {"status": "UP"},"readinessStateProbeIndicator": {"status": "UP"}},"groups": ["liveness","readiness"]
}

readiness

curl http://localhost:8080/actuator/health/readiness

{"components": {"ping": {"status": "UP"}},"status": "UP"
}

liveness

curl http://localhost:8080/actuator/health/liveness

{"components": {"custom": {"details": {"Status": "Health"},"status": "UP"},"diskSpace": {"details": {"exists": true,"free": 380286464000,"threshold": 10485760,"total": 499963174912},"status": "UP"}},"status": "UP"
}

自定义检查项

和自定义健康检查项一样，添加一个新的 HealthIndicator，添加到相应的分组即可

CustomHealthIndicator.java

@Component
public class CustomHealthIndicator implements HealthIndicator {private boolean health = true;@Overridepublic Health health() {if (health) {return Health.up().withDetail("Status", "Health").build();}return Health.down().withDetail("Status", "Not Health").build();}public void setHealth(boolean health) {this.health = health;}
}

applicaiton.properties

management.endpoint.health.group.readiness.include=ping,custom

测试

readiness

curl http://localhost:8080/actuator/health/readiness

{"components": {"custom": {"details": {"Status": "Health"},"status": "UP"},"ping": {"status": "UP"}},"status": "UP"
}

Spring-Boot Liveness 和 Readness 接口使用相关推荐

STS创建Spring Boot项目实战(Rest接口、数据库、用户认证、分布式Token JWT、Redis操作、日志和统一异常处理)
STS创建Spring Boot项目实战(Rest接口.数据库.用户认证.分布式Token JWT.Redis操作.日志和统一异常处理) 1.项目创建 1.新建工程 2.选择打包方式,这边可以选择为打 ...
Spring Boot中使用Convert接口实现类型转换器
在Spring3中引入了一个Converter接口,它支持从一个Object转为另一个Object.除了Converter接口之外,实现ConverterFactory接口和GenericConver ...
boot spring 接口接收数据_基于 Spring Boot 实现 Restful 风格接口，实现增删改查功能...
优质文章,及时送达 Spring Boot介绍 Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程.该框架使用了特定的方式来进行配 ...
Spring Boot设置访问url接口后缀
传统的xml配置方式  <servlet><servlet-name>dispatcherServlet</servl ...
通过Spring boot编写数据查询接口-----练习题
准备:在mysql中准备两张表 ,student表存学生信息的,score表存学生的各科成绩 studnet表 score表例题: 一.通过班级名称查询班级人数(要求加入缓存,这里缓存用的数据库是r ...
Spring Boot 项目的 API 接口防刷
说明:使用了注解的方式进行对接口防刷的功能,非常高大上,本文章仅供参考一,技术要点:springboot的基本知识,redis基本操作, 首先是写一个注解类: import java.lang.an ...
Spring Boot 使用 Swagger3 生成 API 接口文档
前言在之前的文章中,我们已经讲了如何利用 Spring Boot 来集成 Swagger2,详情可戳:Spring Boot 集成 Swagger2,构建强大的 API 文档.但其实 Swagger ...
Spring Boot 缓存应用实践
点击上方蓝色"程序猿DD",选择"设为星标" 回复"资源"获取独家整理的学习资料! 来源:cnblogs.com/jeffwongishan ...
Spring Boot 2.x基础教程：使用JdbcTemplate访问MySQL数据库
点击上方蓝色"程序猿DD",选择"设为星标" 回复"资源"获取独家整理的学习资料! 作者 | 翟永超来源 | didispace.com/ ...

Spring-Boot Liveness 和 Readness 接口使用

Spring Boot Liveness 和 Readness 接口使用

配置

测试

请求相应的接口

自定义检查项

测试

Spring-Boot Liveness 和 Readness 接口使用相关推荐

最新文章

热门文章