指标 （metrics)

终端节点提供对应用程序指标的访问。metricsspring-doc.cn

检索度量名称

要检索可用量度的名称，请向 发出请求，如以下基于 curl 的示例所示：GET/actuator/metricsspring-doc.cn

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

生成的响应类似于以下内容：spring-doc.cn

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" ]
}

响应结构

响应包含指标名称的详细信息。 下表描述了响应的结构：spring-doc.cn

路径 类型 描述

namesspring-doc.cn

Arrayspring-doc.cn

已知指标的名称。spring-doc.cn

检索指标

要检索指标，请向 发出请求，如以下基于 curl 的示例所示：GET/actuator/metrics/{metric.name}spring-doc.cn

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

前面的示例检索有关名为 . 生成的响应类似于以下内容：jvm.memory.maxspring-doc.cn

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'" ]
  } ]
}

查询参数

终端节点使用查询参数通过标签向下钻取到指标。 下表显示了单个支持的查询参数：spring-doc.cn

参数 描述

tagspring-doc.cn

用于表单中向下钻取的标记 。name:valuespring-doc.cn

响应结构

响应包含指标的详细信息。 下表描述了响应的结构：spring-doc.cn

路径 类型 描述

namespring-doc.cn

Stringspring-doc.cn

指标名称spring-doc.cn

descriptionspring-doc.cn

Stringspring-doc.cn

指标描述spring-doc.cn

baseUnitspring-doc.cn

Stringspring-doc.cn

度量的基本单位spring-doc.cn

measurementsspring-doc.cn

Arrayspring-doc.cn

度量的度量spring-doc.cn

measurements[].statisticspring-doc.cn

Stringspring-doc.cn

测量的统计信息。(, , , , , , , ).TOTALTOTAL_TIMECOUNTMAXVALUEUNKNOWNACTIVE_TASKSDURATIONspring-doc.cn

measurements[].valuespring-doc.cn

Numberspring-doc.cn

测量值的值。spring-doc.cn

availableTagsspring-doc.cn

Arrayspring-doc.cn

可用于向下钻取的标记。spring-doc.cn

availableTags[].tagspring-doc.cn

Stringspring-doc.cn

标签的名称。spring-doc.cn

availableTags[].valuesspring-doc.cn

Arrayspring-doc.cn

标签的可能值。spring-doc.cn

向下钻取

要向下钻取到指标，请使用 query 参数发出请求，如以下基于 curl 的示例所示：GET/actuator/metrics/{metric.name}tagspring-doc.cn

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

前面的示例检索量度，其中 tag 的值为 ，attribute 的值为 。 生成的响应类似于以下内容：jvm.memory.maxareanonheapidCompressed Class Spacespring-doc.cn

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" : [ ]
}