此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Boot 3.3.1

此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Boot 3.3.1

终结点提供对应用程序指标的访问。metrics

检索指标名称

要检索可用指标的名称,请向 发出请求,如以下基于 curl 的示例所示:GET/actuator/metrics

$ curl 'http://localhost:8080/actuator/metrics' -i -X GET

生成的响应类似于以下内容:

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 154

{
  "names" : [ "jvm.buffer.count", "jvm.buffer.memory.used", "jvm.buffer.total.capacity", "jvm.memory.committed", "jvm.memory.max", "jvm.memory.used" ]
}

响应结构

响应包含指标名称的详细信息。 下表描述了响应的结构:

路径 类型 描述

names

Array

已知指标的名称。

路径 类型 描述

names

Array

已知指标的名称。

检索指标

若要检索指标,请向 发出请求,如以下基于 curl 的示例所示:GET/actuator/metrics/{metric.name}

$ curl 'http://localhost:8080/actuator/metrics/jvm.memory.max' -i -X GET

前面的示例检索有关名为 的指标的信息。 生成的响应类似于以下内容:jvm.memory.max

HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 555

{
  "name" : "jvm.memory.max",
  "description" : "The maximum amount of memory in bytes that can be used for memory management",
  "baseUnit" : "bytes",
  "measurements" : [ {
    "statistic" : "VALUE",
    "value" : 2.399141885E9
  } ],
  "availableTags" : [ {
    "tag" : "area",
    "values" : [ "heap", "nonheap" ]
  }, {
    "tag" : "id",
    "values" : [ "CodeHeap 'profiled nmethods'", "G1 Old Gen", "CodeHeap 'non-profiled nmethods'", "G1 Survivor Space", "Compressed Class Space", "Metaspace", "G1 Eden Space", "CodeHeap 'non-nmethods'" ]
  } ]
}

查询参数

终结点使用查询参数通过其标签向下钻取指标。 下表显示了单个支持的查询参数:

参数 描述

tag

用于在窗体中向下钻取的标记。name:value

响应结构

响应包含指标的详细信息。 下表描述了响应的结构:

路径 类型 描述

name

String

指标的名称

description

String

指标说明

baseUnit

String

指标的基本单位

measurements

Array

指标的度量

measurements[].statistic

String

测量的统计。(, , , , , , , ).TOTALTOTAL_TIMECOUNTMAXVALUEUNKNOWNACTIVE_TASKSDURATION

measurements[].value

Number

测量值。

availableTags

Array

可用于向下钻取的标记。

availableTags[].tag

String

标记的名称。

availableTags[].values

Array

标记的可能值。

参数 描述

tag

用于在窗体中向下钻取的标记。name:value

路径 类型 描述

name

String

指标的名称

description

String

指标说明

baseUnit

String

指标的基本单位

measurements

Array

指标的度量

measurements[].statistic

String

测量的统计。(, , , , , , , ).TOTALTOTAL_TIMECOUNTMAXVALUEUNKNOWNACTIVE_TASKSDURATION

measurements[].value

Number

测量值。

availableTags

Array

可用于向下钻取的标记。

availableTags[].tag

String

标记的名称。

availableTags[].values

Array

标记的可能值。

向下钻取

若要向下钻取指标,请使用 query 参数发出请求,如以下基于 curl 的示例所示:GET/actuator/metrics/{metric.name}tag

$ curl 'http://localhost:8080/actuator/metrics/jvm.memory.max?tag=area%3Anonheap&tag=id%3ACompressed+Class+Space' -i -X GET

前面的示例检索指标,其中标记的值为 ,属性的值为 。 生成的响应类似于以下内容:jvm.memory.maxareanonheapidCompressed Class Space

HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 263

{
  "name" : "jvm.memory.max",
  "description" : "The maximum amount of memory in bytes that can be used for memory management",
  "baseUnit" : "bytes",
  "measurements" : [ {
    "statistic" : "VALUE",
    "value" : 1.073741824E9
  } ],
  "availableTags" : [ ]
}