Actuator REST API
该 API 文档描述了 Spring Boot Actuator 的 Web 端点。
在继续之前,你应该阅读以下主题:
为了获得下面文档中正确的 JSON 响应,必须提供 Jackson。
URLs
默认情况下,所有 Web 端点都位于路径 /actuator 下,其 URL 格式为 /actuator/{id}。可以通过 management.endpoints.web.base-path 属性配置 /actuator 基础路径,如下例所示:
management.endpoints.web.base-path=/manage
前面的 application.properties 示例将端点 URL 的形式从 /actuator/{id} 更改为 /manage/{id}。例如,info 端点的 URL 将变为 /manage/info。
时间戳
所有由端点消费的时间戳,无论是作为查询参数还是在请求体中,都必须按照 ISO 8601 规定的偏移日期和时间格式进行格式化。
章节总结
📄️ 审计事件(auditevents)
auditevents 端点提供有关应用程序审计事件的信息。
📄️ Beans (beans)
beans 端点提供有关应用程序的 beans 的信息。
📄️ 缓存(caches)
caches 端点提供对应用程序缓存的访问。
📄️ 条件评估报告(conditions)
conditions 端点提供了有关配置类和自动配置类上条件评估的信息。
📄️ 配置属性(configprops)
configprops 端点提供有关应用程序的 @ConfigurationProperties Bean 的信息。
📄️ 环境(env)
env 端点提供有关应用程序 Environment 的信息。
📄️ Flyway (flyway)
flyway 端点提供有关由 Flyway 执行的数据库迁移的信息。
📄️ 健康 (health)
健康端点提供了有关应用程序健康状况的详细信息。
📄️ Heap Dump (heapdump)
heapdump 端点提供应用程序 JVM 的堆转储。
📄️ HTTP 交换 (httpexchanges)
httpexchanges 端点提供有关 HTTP 请求-响应交换的信息。
📄️ Info (info)
info 端点提供有关应用程序的一般信息。
📄️ Spring Integration Graph(integrationgraph)
integrationgraph 端点暴露了一个包含所有 Spring Integration 组件的图。
📄️ Liquibase (liquibase)
liquibase 端点提供有关由 Liquibase 应用的数据库变更集的信息。
📄️ 日志文件 (logfile)
logfile 端点提供对应用程序日志文件内容的访问。
📄️ Loggers(loggers)
loggers 端点提供了对应用程序日志记录器及其级别配置的访问。
📄️ Mappings(mappings)
mappings 端点提供有关应用程序请求映射的信息。
📄️ 指标(metrics)
metrics 端点提供对应用程序指标的访问,用于诊断应用程序记录的指标。在生产环境中,不应“抓取”此端点或将其用作指标后端。其目的是展示当前已注册的指标,以便用户可以查看哪些指标可用、它们的当前值是多少,以及触发某些操作是否会导致某些值发生变化。如果你想通过收集的指标来诊断你的应用程序,应使用外部的指标后端。在这种情况下,metrics 端点仍然可能有用。
📄️ Prometheus (prometheus)
Prometheus 端点以 Prometheus 服务器抓取所需的格式提供 Spring Boot 应用程序的指标。
📄️ Quartz (quartz)
quartz 端点提供由 Quartz Scheduler 管理的作业和触发器的信息。
📄️ Software Bill of Materials (sbom)
sbom 端点提供有关软件物料清单(SBOM)的信息。
📄️ 计划任务(scheduledtasks)
scheduledtasks 端点提供有关应用程序计划任务的信息。
📄️ Sessions (sessions)
sessions 端点提供由 Spring Session 管理的应用程序 HTTP 会话信息。
📄️ Shutdown(shutdown)
shutdown 端点用于关闭应用程序。
📄️ 应用启动(startup)
startup 端点提供有关应用程序启动序列的信息。
📄️ 线程转储(threaddump)
threaddump 端点提供应用程序 JVM 的线程转储。