This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.4!spring-doc.cn

This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.3.4!spring-doc.cn

The metrics endpoint provides access to application metrics.spring-doc.cn

Retrieving Metric Names

To retrieve the names of the available metrics, make a GET request to /actuator/metrics, as shown in the following curl-based example:spring-doc.cn

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

The resulting response is similar to the following: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" ]
}

Response Structure

The response contains details of the metric names. The following table describes the structure of the response:spring-doc.cn

Path Type Description

namesspring-doc.cn

Arrayspring-doc.cn

Names of the known metrics.spring-doc.cn
Path Type Description

namesspring-doc.cn

Arrayspring-doc.cn

Names of the known metrics.spring-doc.cn

Retrieving a Metric

To retrieve a metric, make a GET request to /actuator/metrics/{metric.name}, as shown in the following curl-based example:spring-doc.cn

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

The preceding example retrieves information about the metric named jvm.memory.max. The resulting response is similar to the following:spring-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'" ]
  } ]
}

Query Parameters

The endpoint uses query parameters to drill down into a metric by using its tags. The following table shows the single supported query parameter:spring-doc.cn

Parameter Description

tagspring-doc.cn

A tag to use for drill-down in the form name:value.spring-doc.cn

Response Structure

The response contains details of the metric. The following table describes the structure of the response:spring-doc.cn

Path Type Description

namespring-doc.cn

Stringspring-doc.cn

Name of the metricspring-doc.cn

descriptionspring-doc.cn

Stringspring-doc.cn

Description of the metricspring-doc.cn

baseUnitspring-doc.cn

Stringspring-doc.cn

Base unit of the metricspring-doc.cn

measurementsspring-doc.cn

Arrayspring-doc.cn

Measurements of the metricspring-doc.cn

measurements[].statisticspring-doc.cn

Stringspring-doc.cn

Statistic of the measurement. (TOTAL, TOTAL_TIME, COUNT, MAX, VALUE, UNKNOWN, ACTIVE_TASKS, DURATION).spring-doc.cn

measurements[].valuespring-doc.cn

Numberspring-doc.cn

Value of the measurement.spring-doc.cn

availableTagsspring-doc.cn

Arrayspring-doc.cn

Tags that are available for drill-down.spring-doc.cn

availableTags[].tagspring-doc.cn

Stringspring-doc.cn

Name of the tag.spring-doc.cn

availableTags[].valuesspring-doc.cn

Arrayspring-doc.cn

Possible values of the tag.spring-doc.cn
Parameter Description

tagspring-doc.cn

A tag to use for drill-down in the form name:value.spring-doc.cn
Path Type Description

namespring-doc.cn

Stringspring-doc.cn

Name of the metricspring-doc.cn

descriptionspring-doc.cn

Stringspring-doc.cn

Description of the metricspring-doc.cn

baseUnitspring-doc.cn

Stringspring-doc.cn

Base unit of the metricspring-doc.cn

measurementsspring-doc.cn

Arrayspring-doc.cn

Measurements of the metricspring-doc.cn

measurements[].statisticspring-doc.cn

Stringspring-doc.cn

Statistic of the measurement. (TOTAL, TOTAL_TIME, COUNT, MAX, VALUE, UNKNOWN, ACTIVE_TASKS, DURATION).spring-doc.cn

measurements[].valuespring-doc.cn

Numberspring-doc.cn

Value of the measurement.spring-doc.cn

availableTagsspring-doc.cn

Arrayspring-doc.cn

Tags that are available for drill-down.spring-doc.cn

availableTags[].tagspring-doc.cn

Stringspring-doc.cn

Name of the tag.spring-doc.cn

availableTags[].valuesspring-doc.cn

Arrayspring-doc.cn

Possible values of the tag.spring-doc.cn

Drilling Down

To drill down into a metric, make a GET request to /actuator/metrics/{metric.name} using the tag query parameter, as shown in the following curl-based example:spring-doc.cn

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

The preceding example retrieves the jvm.memory.max metric, where the area tag has a value of nonheap and the id attribute has a value of Compressed Class Space. The resulting response is similar to the following:spring-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" : [ ]
}