一、Spring Boot Actuator端点简介
1.1 什么是Actuator端点
Spring Boot Actuator 是一个用于监控和管理 Spring Boot 应用程序的子项目。它提供了一系列内置的端点(Endpoints),这些端点可以用于查看应用程序的状态、运行情况和运行指标。Actuator 端点可以以 HTTP、JMX 或其他形式暴露给外部系统,便于运维人员对应用程序进行监控、诊断和管理。
1.2 端点的作用和功能
Actuator端点主要用于实现以下功能:
- 提供应用程序的健康检查,包括数据库连接、缓存、消息队列等
- 收集应用程序的度量数据,例如内存使用情况、GC情况、线程状态等
- 查看应用程序的配置信息,包括环境变量、系统属性、配置文件中的属性等
- 管理应用程序的日志,包括查看和动态修改日志级别
- 获取应用程序的 Spring Bean 信息,以及应用程序的元数据等
- 提供应用程序的关闭功能等
1.3 Actuator端点的默认配置
Spring Boot Actuator 默认提供了一系列内置端点,这些端点在开发环境下可以直接访问,但在生产环境中,可能需要对端点进行权限控制和暴露策略的配置。Actuator的端点可以通过 application.properties 或 application.yml 文件进行配置。例如,可以通过配置
management.endpoints.web.exposure.include 来控制哪些端点暴露给外部访问,或者通过 management.endpoints.web.base-path 来修改端点的URL路径。
二、内置端点详解
Spring Boot Actuator 提供了许多内置端点,用于查看和管理应用程序的不同方面。以下是一些常用端点的详细介绍:
2.1 /actuator/health
这个端点用于查看应用程序的健康状态。它会检查各个组件的状态,如数据库连接、缓存、消息队列等。返回的状态包括 UP(正常)、DOWN(异常)和 OUT_OF_SERVICE(维护中)等。
2.2 /actuator/info
此端点用于展示应用程序的基本信息,如版本号、构建时间等。这些信息通常来源于应用程序的配置文件或构建系统。
2.3 /actuator/metrics
此端点用于查看应用程序的度量数据。它收集了关于内存使用、GC、线程状态等方面的数据。可以通过添加参数来查看特定度量的详细信息,例如: