Metrics (metrics)

QWen Max 中英对照 Metrics (metrics) Metrics (metrics)

metrics 端点提供对应用程序指标的访问，用于诊断应用程序记录的指标。在生产环境中，不应“抓取”此端点或将其用作指标后端。其目的是展示当前已注册的指标，以便用户可以查看哪些指标可用、它们的当前值是多少，以及触发某些操作是否会导致某些值发生变化。如果你想通过应用程序收集的指标来诊断应用程序，应使用外部指标后端。在这种情况下，metrics 端点仍然可能有用。

获取指标名称

要获取可用指标的名称，请向 /actuator/metrics 发起 GET 请求，如下列基于 curl 的示例所示：

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

响应结构

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

Path	Type	Description
names	Array	已知指标的名称。

获取指标

要获取一个指标，向 /actuator/metrics/{metric.name} 发起 GET 请求，如下列基于 curl 的示例所示：

$ 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

{
  "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'" ]
  } ],
  "baseUnit" : "bytes",
  "description" : "The maximum amount of memory in bytes that can be used for memory management",
  "measurements" : [ {
    "statistic" : "VALUE",
    "value" : 2.936012797E9
  } ],
  "name" : "jvm.memory.max"
}

查询参数

该端点使用查询参数通过标签对指标进行下钻。下表显示了唯一支持的查询参数：

参数	描述
tag	用于下钻的标签，格式为 name:value。

响应结构

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

路径	类型	描述
name	String	指标名称
description	String	指标描述
baseUnit	String	指标的基准单位
measurements	Array	指标的测量值
measurements[].statistic	String	测量值的统计类型。（TOTAL、TOTAL_TIME、COUNT、MAX、VALUE、UNKNOWN、ACTIVE_TASKS、DURATION）
measurements[].value	Number	测量值
availableTags	Array	可用于下钻分析的标签
availableTags[].tag	String	标签名称
availableTags[].values	Array	标签的可能取值

下钻

要深入查看某个指标，请使用 tag 查询参数向 /actuator/metrics/{metric.name} 发起 GET 请求，如下列基于 curl 的示例所示：

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

前面的示例获取了 jvm.memory.max 指标，其中 area 标签的值为 nonheap，id 属性的值为 Compressed 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

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