Spring Boot Actuator
Spring Boot Actuator 是 Spring Boot 提供的监控与管理功能,通过管理端点展示健康状态、指标、配置和启动步骤等信息。它能帮助我们判断实例是否该接收请求,也能为启动慢、路由缺失等问题提供排查依据。
使用 Actuator,关键是分清端点能证明什么,以及检查失败后平台会做什么。管理接口正常响应,不等于业务请求一定能完成;需要重启进程和暂时停止接收流量,也应分别判断。本文以 Boot 3.5 为准。
1. 面试核心
先记住这几条,再读正文management.endpoints.web.exposure.include决定 HTTP 暴露范围,开放端点后仍需配置认证与授权。- liveness 失败达到阈值后,平台会重启实例;readiness 失败后,平台会停止向该实例转发流量。卡 · 常用端点
- Boot 默认的 liveness 与 readiness 健康组只读取应用发布的存活状态和就绪状态,不会自动检测所有故障。
BufferingApplicationStartup采集启动步骤,startup端点展示已记录的耗时,未埋点的业务初始化仍需补充计时。- 独立管理端口上的探针成功,只能证明管理服务路径可用,业务接入路径需要从主端口探测。卡 · 业务端口探针
2. 常用端点
端点是供监控或运维工具调用的管理接口。不同端点提供不同信息,可以按要排查的问题选择:
| 端点 | 信息 |
|---|---|
health | 组件健康状态与健康组 |
metrics、prometheus | 指标查询与 Prometheus 抓取 |
conditions | 自动配置匹配报告 |
configprops、env | 配置绑定与属性来源 |
beans、mappings | Bean 与 Web 路由 |
startup | 启动步骤 |
loggers | 日志级别查询与调整 |
threaddump、heapdump | 线程与堆诊断 |
metrics 用于查询指标名称、标签和值,prometheus 则提供监控系统可抓取的格式。后者需要 micrometer-registry-prometheus 依赖。Boot 3.5 默认只通过 HTTP 暴露 health,其他端点要按需开放。
3. 端点暴露与访问控制
一个端点能否使用,要分别看它允许哪些操作、是否对外暴露,以及当前请求有没有权限:
- 操作权限决定端点允许读取还是修改状态。
- 网络暴露决定端点能否通过 HTTP 等方式访问。
- 请求鉴权决定哪些调用方有权访问端点。
下面的配置声明 HTTP 暴露范围,并限制健康详情的展示:
management:
endpoints:
web:
exposure:
include: health,info,prometheus
endpoint:
health:
show-details: when_authorized
示例通过 include 暴露 health、info 和 prometheus。show-details: when_authorized 让健康详情只对获授权的调用方展示。具体的认证与授权仍由安全过滤链负责,也就是在请求到达端点前检查身份和权限。
Boot 3.5 用 management.endpoint.<id>.access 限制端点本身允许的操作,支持三种取值:
none禁止访问该端点。read-only只允许读取操作。unrestricted允许端点提供的读取和写入操作。
应用自定义 SecurityFilterChain 后,Boot 会停止自动配置管理端点的安全规则。这时需要由应用显式指定哪些请求允许访问,不能把“端点已暴露”当作“权限已配置”。
生产环境只向探针和监控系统开放所需端点。其他诊断端点可以放在独立管理端口或受控内网,并配置认证。临时运维访问也要按权限开放。
env、configprops、堆转储和线程栈会暴露内部信息。例如其中会包含地址、类名、查询、令牌或用户数据。因此,获取或分享这些结果前,要核对脱敏效果和访问权限,尤其检查自定义属性。
4. Liveness 探针
存活探针(liveness probe)用于判断应用内部是否陷入无法自行恢复的状态。探测失败达到配置的阈值后,平台会重启实例,尝试恢复服务。
数据库、缓存和远程 API 的故障应由连接超时、重试或降级处理。重启本地进程无法恢复这些外部服务。若把共享依赖加入 liveness,一次依赖故障就会触发所有实例反复重启,形成重启风暴。
Boot 的 LivenessStateHealthIndicator 读取的是应用发布的存活状态,不会自动发现所有线程死锁或内部状态损坏。这类故障需要专门的检测逻辑,检测到后再发布存活状态变化,或者通过对应的健康检查报告失败。
5. Readiness 探针
就绪探针(readiness probe)用于判断实例当前是否应接收流量。启动尚未完成、正在优雅下线或关键能力暂时不可用时,实例可以报告未就绪。平台随后停止向它转发请求,进程仍可继续运行或完成清理。
健康组是按用途组织的一组健康检查。Boot 的默认 readiness 组只包含 readinessState,也就是应用发布的就绪状态。
是否把数据库等外部依赖加入 readiness 组,要看依赖失效后还能提供什么功能。所有请求都必须访问数据库时,可以把数据库检查加入该组;如果仍能提供缓存读取、静态接口或排队能力,就要考虑是否保留这些服务。否则,一次共享数据库故障会让全部实例同时停止接收流量,连原本还能使用的功能也一并失效。
两类探针都要分别设置超时、探测周期和失败阈值,给正常抖动留出余量。阈值过低,会把短暂等待变成重启或停止转发流量。启动较慢时,可用平台的 startup probe,也就是启动探针,保护启动阶段。
6. 启动阶段分析
分析启动慢,要先找到耗时的具体步骤。BufferingApplicationStartup 会保存启动过程中采集到的步骤信息,应用可以这样启用它:
SpringApplication app = new SpringApplication(OrderApplication.class);
app.setApplicationStartup(new BufferingApplicationStartup(2048));
app.run(args);
配置后,再按需暴露 startup 端点,就能查看已采集的启动步骤。也可改用 FlightRecorderApplicationStartup,把启动事件写入 JFR。JFR 是 JVM 的事件记录工具,可把启动过程与类加载、对象分配和 GC 事件关联起来。
拿到记录后,可以沿启动过程检查耗时:
- 检查配置数据读取和条件评估花了多久。
- 检查 BeanDefinition 处理,也就是容器解析和调整对象定义的耗时。
- 检查 Bean 创建与生命周期回调是否等待外部操作。
- 分别检查 Web 服务器、数据库迁移和连接池初始化。
- 为 Runner 和自定义预热单独计时。
Runner 是 Boot 在上下文刷新后执行的启动任务。记录器只包含实际埋点的操作,所以业务代码的耗时还需自行补充。这样才能区分框架处理、业务初始化和外部依赖等待。
7. 诊断端点选择
诊断端点要按待验证的故障原因选择。先获取能缩小排查范围的信息,再决定是否需要开销更大的诊断操作:
- Bean 缺失时,查看
conditions与beans。 - 配置值异常时,查看
env与configprops,确认值来自哪个配置源,以及最终绑定到了什么字段。 - 路由缺失时,查看
mappings。 - 延迟或错误率上升时,结合指标、trace ID 和请求日志定位异常请求。
- 线程阻塞时,连续获取线程转储并比较调用栈。
- 内存持续增长时,先观察 GC,再按需获取堆转储。
trace ID 是一次请求链路的关联标识,可用来查找同一请求的日志。堆转储会增加诊断开销,应在资源允许时执行。按问题逐步取证,能避免同时下载大量诊断结果给服务增加负载。
8. 业务端口探针
独立管理端口返回健康,不代表业务端口一定能接收请求。两个端口有各自的连接和请求处理路径,管理端口响应成功时,业务端口仍可能阻塞。因此,还需要让探针经过业务端口:
management:
endpoint:
health:
probes:
enabled: true
add-additional-paths: true
Boot 3.5 使用上述配置在主端口增加 /livez 与 /readyz。健康组原路径仍是 /actuator/health/liveness 和 /actuator/health/readiness。平台探测主端口,才能覆盖业务端口的接入路径。
健康状态为 DOWN 或 OUT_OF_SERVICE 时,默认返回 HTTP 503。自定义状态映射时,应保留这两个失败映射。
9. 常见问题
9.1 health 返回 UP 就能证明业务正常吗?
不能。UP 只表示本次执行的健康检查通过。数据库可以连接,实际查询仍可能遇到权限、数据延迟或业务规则问题。判断业务是否正常,还要结合业务指标和真实请求错误率。
可以再用低频合成请求覆盖关键业务路径。合成请求是监控系统主动发出的测试请求,用于验证一条业务流程能否完成。
9.2 健康检查应该执行真实 SQL 吗?
可以执行有超时的轻量连通性查询。高频探针应避免复杂查询和业务关键锁竞争,否则检查本身就会增加请求延迟。更深入的校验可以放在低频合成监控中,并设置独立超时和容量限制。
10. 面试题卡片
11. 参考资料
- Spring Boot:Endpoints
- Spring Boot:Application Availability
- Spring Boot:Application Startup Tracking
- Spring Boot 3.5:Endpoints
来源:Coding 101 原文 · 免费阅读,引用请保留出处。内容使用说明