对于最新稳定版本，请使用 Spring Boot 4.0.4！spring-doc.cadn.net.cn

Prometheus（prometheus）

prometheus 端点以 Prometheus 服务器抓取所需的格式提供 Spring Boot 应用程序的指标。spring-doc.cadn.net.cn

检索所有指标

要获取所有指标，请向 GET 发起一个 /actuator/prometheus 请求，如下列基于 curl 的示例所示：spring-doc.cadn.net.cn

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

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

HTTP/1.1 200 OK
Content-Type: text/plain;version=0.0.4;charset=utf-8
Content-Length: 3089

# HELP jvm_buffer_count_buffers An estimate of the number of buffers in the pool
# TYPE jvm_buffer_count_buffers gauge
jvm_buffer_count_buffers{id="direct"} 3.0
jvm_buffer_count_buffers{id="mapped"} 0.0
jvm_buffer_count_buffers{id="mapped - 'non-volatile memory'"} 0.0
# HELP jvm_buffer_memory_used_bytes An estimate of the memory that the Java virtual machine is using for this buffer pool
# TYPE jvm_buffer_memory_used_bytes gauge
jvm_buffer_memory_used_bytes{id="direct"} 45056.0
jvm_buffer_memory_used_bytes{id="mapped"} 0.0
jvm_buffer_memory_used_bytes{id="mapped - 'non-volatile memory'"} 0.0
# HELP jvm_buffer_total_capacity_bytes An estimate of the total capacity of the buffers in this pool
# TYPE jvm_buffer_total_capacity_bytes gauge
jvm_buffer_total_capacity_bytes{id="direct"} 45056.0
jvm_buffer_total_capacity_bytes{id="mapped"} 0.0
jvm_buffer_total_capacity_bytes{id="mapped - 'non-volatile memory'"} 0.0
# HELP jvm_memory_committed_bytes The amount of memory in bytes that is committed for the Java virtual machine to use
# TYPE jvm_memory_committed_bytes gauge
jvm_memory_committed_bytes{area="heap",id="G1 Eden Space"} 7.2351744E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.2058624E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 5242880.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3538944.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9922944E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.2058624E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.6245376E7
# HELP jvm_memory_max_bytes The maximum amount of memory in bytes that can be used for memory management
# TYPE jvm_memory_max_bytes gauge
jvm_memory_max_bytes{area="heap",id="G1 Eden Space"} -1.0
jvm_memory_max_bytes{area="heap",id="G1 Old Gen"} 1.610612736E9
jvm_memory_max_bytes{area="heap",id="G1 Survivor Space"} -1.0
jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 5836800.0
jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 1.22912768E8
jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.22908672E8
jvm_memory_max_bytes{area="nonheap",id="Compressed Class Space"} 1.073741824E9
jvm_memory_max_bytes{area="nonheap",id="Metaspace"} -1.0
# HELP jvm_memory_used_bytes The amount of used memory
# TYPE jvm_memory_used_bytes gauge
jvm_memory_used_bytes{area="heap",id="G1 Eden Space"} 3.7748736E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 8.4082176E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4834384.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1429248.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3515776.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9879552E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.1631144E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.5408064E7

默认的响应内容类型为 text/plain;version=0.0.4。 当使用适当的 application/openmetrics-text;version=1.0.0 请求头调用该端点时，它也可以生成 Accept，如下列基于 curl 的示例所示：spring-doc.cadn.net.cn

$ curl 'http://localhost:8080/actuator/prometheus' -i -X GET \
    -H 'Accept: application/openmetrics-text; version=1.0.0; charset=utf-8'

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

HTTP/1.1 200 OK
Content-Type: application/openmetrics-text;version=1.0.0;charset=utf-8
Content-Length: 3094

# TYPE jvm_buffer_count_buffers gauge
# HELP jvm_buffer_count_buffers An estimate of the number of buffers in the pool
jvm_buffer_count_buffers{id="direct"} 3.0
jvm_buffer_count_buffers{id="mapped"} 0.0
jvm_buffer_count_buffers{id="mapped - 'non-volatile memory'"} 0.0
# TYPE jvm_buffer_memory_used_bytes gauge
# HELP jvm_buffer_memory_used_bytes An estimate of the memory that the Java virtual machine is using for this buffer pool
jvm_buffer_memory_used_bytes{id="direct"} 45056.0
jvm_buffer_memory_used_bytes{id="mapped"} 0.0
jvm_buffer_memory_used_bytes{id="mapped - 'non-volatile memory'"} 0.0
# TYPE jvm_buffer_total_capacity_bytes gauge
# HELP jvm_buffer_total_capacity_bytes An estimate of the total capacity of the buffers in this pool
jvm_buffer_total_capacity_bytes{id="direct"} 45056.0
jvm_buffer_total_capacity_bytes{id="mapped"} 0.0
jvm_buffer_total_capacity_bytes{id="mapped - 'non-volatile memory'"} 0.0
# TYPE jvm_memory_committed_bytes gauge
# HELP jvm_memory_committed_bytes The amount of memory in bytes that is committed for the Java virtual machine to use
jvm_memory_committed_bytes{area="heap",id="G1 Eden Space"} 7.2351744E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.2058624E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 5242880.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3538944.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9857408E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.2058624E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.6114304E7
# TYPE jvm_memory_max_bytes gauge
# HELP jvm_memory_max_bytes The maximum amount of memory in bytes that can be used for memory management
jvm_memory_max_bytes{area="heap",id="G1 Eden Space"} -1.0
jvm_memory_max_bytes{area="heap",id="G1 Old Gen"} 1.610612736E9
jvm_memory_max_bytes{area="heap",id="G1 Survivor Space"} -1.0
jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 5836800.0
jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 1.22912768E8
jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.22908672E8
jvm_memory_max_bytes{area="nonheap",id="Compressed Class Space"} 1.073741824E9
jvm_memory_max_bytes{area="nonheap",id="Metaspace"} -1.0
# TYPE jvm_memory_used_bytes gauge
# HELP jvm_memory_used_bytes The amount of used memory
jvm_memory_used_bytes{area="heap",id="G1 Eden Space"} 3.5651584E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 8.4082176E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4834384.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1429248.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3511936.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.985728E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.1619024E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.5268936E7
# EOF

查询参数

该端点使用查询参数来限制其返回的样本。 下表列出了支持的查询参数：spring-doc.cadn.net.cn

参数 <description> </description>

includedNamesspring-doc.cadn.net.cn

将示例限制为与名称匹配的那些。可选。spring-doc.cadn.net.cn

检索过滤后的指标

要检索匹配特定名称的指标，请向 GET 发起一个 /actuator/prometheus 请求，并附带 includedNames 查询参数，如下列基于 curl 的示例所示：spring-doc.cadn.net.cn

$ curl 'http://localhost:8080/actuator/prometheus?includedNames=jvm_memory_used_bytes%2Cjvm_memory_committed_bytes' -i -X GET

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

HTTP/1.1 200 OK
Content-Type: text/plain;version=0.0.4;charset=utf-8
Content-Length: 1459

# HELP jvm_memory_committed_bytes The amount of memory in bytes that is committed for the Java virtual machine to use
# TYPE jvm_memory_committed_bytes gauge
jvm_memory_committed_bytes{area="heap",id="G1 Eden Space"} 7.2351744E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.2058624E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 5242880.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3538944.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9922944E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.2058624E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.6245376E7
# HELP jvm_memory_used_bytes The amount of used memory
# TYPE jvm_memory_used_bytes gauge
jvm_memory_used_bytes{area="heap",id="G1 Eden Space"} 3.8797312E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 8.4082176E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4834384.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1436032.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3536640.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.99008E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.163232E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.5418832E7