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

Prometheus （prometheus)

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

检索所有指标

要检索所有指标，请创建一个GETrequest 添加到/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: 3097

# 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"} 16.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"} 1.7043464E7
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"} 1.7043463E7
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"} 1.9398656E8
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.16391936E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 4194304.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4587520.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9398656E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.2320768E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.8932352E7
# 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.073741824E9
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"} 1.13246208E8
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 7.9899136E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 3453024.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1446400.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4526464.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.939136E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.18666E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.8070104E7

默认响应内容类型为text/plain;version=0.0.4. 端点还可以生成application/openmetrics-text;version=1.0.0当使用适当的Acceptheader，如以下基于 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: 3105

# 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"} 16.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"} 1.7043464E7
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"} 1.7043463E7
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"} 1.9398656E8
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.16391936E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 4194304.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4587520.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9398656E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.2320768E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.8932352E7
# 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.073741824E9
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"} 1.12197632E8
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 7.9899136E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 3453024.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1446400.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4524160.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9349376E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.186268E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.8035072E7
# EOF

查询参数

终端节点使用查询参数来限制它返回的样本。 下表显示了支持的查询参数：spring-doc.cadn.net.cn

参数 描述

includedNamesspring-doc.cadn.net.cn

将样本限制为与名称匹配的样本。自选。spring-doc.cadn.net.cn

检索筛选的指标

要检索与特定名称匹配的指标，请创建一个GETrequest 添加到/actuator/prometheus使用includedNamesquery 参数，如以下基于 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: 1461

# 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"} 1.9398656E8
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.16391936E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 4194304.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4653056.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9464192E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.2320768E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.8997888E7
# 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"} 1.14294784E8
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 7.9899136E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 3453024.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1446400.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4601600.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9411328E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.18672E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.807728E7