1、展示健康信息详情
开发者可以通过查看健康信息来获取应用的运行数据,进而提早发现应用问题,提早解决,
免造成损失。默认情况下开发者只能获取 status 信息(见图 1 ),这是因为 detail 信息默认不显示,开发者可以通过 maagement.endpoint.health.show-details 属性来配 detail 信息的显示策略,该属性的取值共有三种:
- never:即不显示 details 信息,默认即此。
- when-authorized:details 信息只展示给认证用户,即用户登录后可以查看 details 信息,未登录则不能查看,另外还可以通过management.endpoint.health.roles 配置要求的角色,如果不配置,那么通过认证的用户都可以查看 details 信息 ,如果配置了 ,例如 management.endpoint.health.roles= admin,表示认证的用户必须具有 admin 角色才能查看 details 信息。
- always:details 信息展示给所有用户。
management.endpoints.web.exposure.include=*
spring.security.user.name=admin
spring.security.user.password=123456
spring.security.user.roles=admin
management.endpoint.health.show-details=when_authorized
登陆后访问health端点
2、健康指示器
Spring Boot 会根 classpath 中依赖的添加情况来自动配置 Healthlndicators
如果项目中存在相关的依赖,那么列表中对应的 Healthlndicators 将会自动配置 ,例如在 pom.xml 文件中添加 Redis ,此时访问 health 端点。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
若开发者不需要这么多 Healthlndicators ,则可以通过如下配置关闭所有的 Healthlndicators 自动化配置
management.health.defaults.enabled=false
3、自定义 Health Info
除了 Spring Boot 自动收集的这些 Healthlnfo 之外,开发者也可以自定义 Healthlnfo 只需要实现 Healthlndicator 接口即可:
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;
@Component
public class MyHealth implements HealthIndicator {
@Override
public Health health() {
return Health.up().withDetail("msg:", "up").build();
// return Health.down().withDetail("msg:", "down").build();
}
}
如果开发者想要增加其他响应状态,比如FATAL ,在 application.properties 中增加如下配置:
management.health.status.order=FATAL,DOWN,OUT_OF_SERVICE,UP,UNKNOWN
@Override
public Health health() {
// return Health.up().withDetail("msg:", "up").build();
// return Health.down().withDetail("msg:", "down").build();
return Health.status("FATAL").withDetail("msg:", "测试").build();
}
修改完成后,此时启动 Spring Boot 项目,访问 health 端点:
注意 ,此时虽然返回的 status 为 FATAL ,但是 HTTP 响应码是 200 ,在默认的4种响应状态码中, DOWN
、OUT_OF_SERVICE
应码为 503, UP
、UNKNOWN
的 HTTP 响应码为 200,如果开发者需要对自定义的响应状态配置响应码,添加如下配置即可:
management.health.status.http-mapping.FATAL=503