Actuator REST API
本 API 文档描述了 Spring Boot Actuator 的 Web 端点。
在继续之前,您应该阅读以下主题:
为了获取如下文档中描述的正确的 JSON 响应,必须确保 Jackson 可用。
网址
默认情况下,所有的 Web 端点都可以通过路径 /actuator
访问,其 URL 形式为 /actuator/{id}
。/actuator
基础路径可以通过使用 management.endpoints.web.base-path
属性进行配置,如下例所示:
management.endpoints.web.base-path=/manage
前面的 application.properties
示例将端点 URL 的形式从 /actuator/{id}
更改为 /manage/{id}
。例如,info
端点的 URL 将变为 /manage/info
。
时间戳
所有被端点使用的时间戳,无论是作为查询参数还是请求体中的内容,都必须按照 ISO 8601 标准格式化为带偏移量的日期和时间。
章节摘要
📄️ 审计事件 (auditevents)
auditevents 端点提供了有关应用程序的审计事件信息。
📄️ Beans (beans)
beans 端点提供了有关应用程序的 bean 信息。
📄️ 缓存(caches)
caches 端点提供了对应用程序缓存的访问权限。
📄️ 条件评估报告(conditions)
conditions 端点提供了关于配置类和自动配置类上条件评估的信息。
📄️ 配置属性 (configprops)
configprops 端点提供了有关应用程序的 @ConfigurationProperties bean 的信息。
📄️ 环境 (env)
env 端点提供有关应用程序环境的信息。
📄️ Flyway (flyway)
Flyway 端点提供了有关 Flyway 执行的数据库迁移的信息。
📄️ 健康 (Health)
健康端点提供了关于应用程序健康状态的详细信息。
📄️ Heap Dump(heapdump)
heapdump 端点提供了从应用程序的 JVM 中获取的堆转储。
📄️ HTTP 交换(httpexchanges)
httpexchanges 端点提供了关于 HTTP 请求-响应交换的信息。
📄️ 信息 (info)
info 端点提供了关于应用程序的常规信息。
📄️ Spring Integration 图表 (integrationgraph)
integrationgraph 端点公开了一个包含所有 Spring Integration 组件的图表。
📄️ Liquibase(liquibase)
Liquibase 端点提供了关于 Liquibase 应用的数据库变更集的信息。
📄️ 日志文件 (logfile)
日志文件端点提供对应用程序日志文件内容的访问权限。
📄️ 日志记录器(Loggers)
日志记录器端点提供对应用程序日志记录器及其级别配置的访问。
📄️ 映射 (mappings)
mappings 端点提供了关于应用程序的请求映射的信息。
📄️ 指标(metrics)
指标端点提供了对应用指标的访问。
📄️ 普罗米修斯 (Prometheus)
Prometheus 端点提供了 Spring Boot 应用程序的指标,这些指标以 Prometheus 服务器抓取所需的格式呈现。
📄️ Quartz(quartz)
quartz 端点提供了由 Quartz Scheduler 管理的作业和触发器的相关信息。
📄️ 软件物料清单 (Software Bill of Materials, SBOM)
sbom 端点提供了有关软件物料清单 (SBOM) 的信息。
📄️ 定时任务(scheduledtasks)
scheduledtasks 端点提供了有关应用程序的预定任务的信息。
📄️ 会话(sessions)
sessions 端点提供了有关由 Spring Session 管理的应用程序 HTTP 会话的信息。
📄️ 关闭(shutdown)
shutdown 端点用于关闭应用程序。
📄️ 应用启动 (startup)
startup 端点提供了有关应用程序启动顺序的信息。
📄️ 线程转储 (Thread Dump)
threaddump 端点提供了从应用程序的 JVM 中获取的线程转储信息。