⚒️Spring Boot Monitor API 文档

type
status
date
slug
summary
tags
category
icon
password

概述

本文档描述了Spring Boot Monitor系统提供的所有REST API接口，包括返回数据结构和示例。所有API都使用统一的响应格式 ApiResponse<T>。

统一响应格式

所有API接口都返回以下统一格式：

响应字段说明

字段
类型
说明
code
int
业务状态码，200表示成功，其他表示错误
message
string
提示信息
data
object
业务数据，成功时包含具体数据，失败时为null

常见错误码

错误码
说明
200
操作成功
400
请求参数错误
404
资源不存在
500
服务器内部错误
600
监控数据获取失败
601
Druid指标收集失败
602
线程控制操作失败
603
Bean内存监控失败

1. Druid监控接口

1.1 获取Druid指标快照

接口地址： GET /monitor/druid/druid-snapshot
功能描述： 获取当前Druid指标的完整快照对象
响应示例：

1.2 获取Druid指标数据（JSON格式）

接口地址： GET /monitor/druid/druid-metrics
功能描述： 获取结构化的Druid指标数据，更适合前端展示
响应示例：

1.3 获取可用指标列表

接口地址： GET /monitor/druid/druid-metrics/available
功能描述： 获取所有可用的Druid监控指标名称列表
响应示例：

1.4 获取指定指标详情

接口地址： GET /monitor/druid/druid-metrics/{metricName}
功能描述： 获取指定指标的详细信息
路径参数：
  • metricName: 指标名称
响应示例：

1.5 获取连接池状态

接口地址： GET /monitor/druid/druid-connection-pool
功能描述： 获取连接池状态的简化视图
响应示例：

1.6 获取SQL执行统计

接口地址： GET /monitor/druid/druid-sql-stats
功能描述： 获取SQL执行统计的简化视图
响应示例：

1.7 获取健康状态

接口地址： GET /monitor/druid/druid-health
功能描述： 获取Druid连接池的健康状态评估
响应示例：

2. 方法监控统计接口

2.1 获取所有方法统计信息

接口地址： GET /monitor/stats
功能描述： 获取所有被监控方法的统计信息
响应示例：

2.2 获取指定方法统计信息

接口地址： GET /monitor/stats/{methodName}
功能描述： 获取指定方法的统计信息
路径参数：
  • methodName: 方法全名（包含类名）
响应示例：

2.3 重置所有统计信息

接口地址： DELETE /monitor/stats
功能描述： 重置所有方法的统计信息
响应示例：

2.4 重置指定方法统计信息

接口地址： DELETE /monitor/stats/{methodName}
功能描述： 重置指定方法的统计信息
路径参数：
  • methodName: 方法全名（包含类名）
响应示例：

3. Bean内存监控接口

3.1 获取Bean内存使用情况

接口地址： GET /monitor/memory/{beanName}
功能描述： 获取指定Bean的内存使用情况
路径参数：
  • beanName: Bean名称
响应示例：
字段说明：
  • shallowHeapSize: 浅堆大小（字节）
  • deepHeapSize: 深堆大小（字节）
  • shallowHeapSizeFormatted: 格式化的浅堆大小
  • deepHeapSizeFormatted: 格式化的深堆大小

4. 线程控制管理接口

4.1 获取线程控制状态

接口地址： GET /monitor/thread-control-admin/status
功能描述： 获取线程控制规则的状态信息
查询参数：
  • name (可选): 规则名称，不提供则返回所有规则状态
响应示例（获取所有规则）：
响应示例（获取指定规则）：

4.2 更新线程控制规则

接口地址： POST /monitor/thread-control-admin/update
功能描述： 更新线程控制规则配置
请求体示例：
响应示例：

错误响应示例

资源不存在

服务异常

参数错误

使用建议

  1. 监控仪表板集成
      • 使用 /monitor/druid/druid-metrics 获取结构化数据
      • 使用 /monitor/druid/druid-connection-pool 和 /monitor/druid/druid-sql-stats 获取分类视图
      • 使用 /monitor/druid/druid-health 进行健康状态监控
  1. 性能监控
      • 定期调用 /monitor/stats 获取方法执行统计
      • 监控 /monitor/memory/{beanName} 跟踪内存使用
  1. 运维管理
      • 使用 /monitor/thread-control-admin/status 监控线程池状态
      • 通过 /monitor/thread-control-admin/update 动态调整线程控制规则
  1. 错误处理
      • 始终检查响应中的 code 字段
      • 根据不同的错误码进行相应的错误处理
      • 在 code 不为 200 时，message 字段包含详细的错误信息
  1. 数据格式
      • 所有时间戳使用毫秒级Unix时间戳
      • 内存大小提供原始字节数和格式化字符串两种格式
      • 百分比数据保留两位小数
Prev
spring-boot-monitor ReadMe
Next
三个层面分析Druid数据
Loading...