Prometheus (prometheus)

prometheus 端点以 Prometheus 服务器抓取所需的格式提供 Spring Boot 应用程序的指标。

获取所有指标

要获取所有指标，向 /actuator/prometheus 发送 GET 请求，如下面的基于 curl 的示例所示：

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

响应结果类似于以下内容：

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

# 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"} 53248.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"} 53248.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"} 4.4040192E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 9.3323264E7
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 6291456.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 5046272.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 2.1102592E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1075584E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.9364096E7
# 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'"} 5849088.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.22896384E8
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"} 6291456.0
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 8.0830144E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 6053672.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1592704.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4964096.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8715008E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.06276E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.845644E7

默认响应内容类型为 text/plain;version=0.0.4。 当使用适当的 Accept 头调用时，端点也可以生成 application/openmetrics-text;version=1.0.0，如下面的基于 curl 的示例所示：

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

响应结果类似于以下内容：

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

# 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"} 53248.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"} 53248.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"} 4.4040192E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 9.3323264E7
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 6291456.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 5046272.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 2.1102592E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1075584E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.9233024E7
# 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'"} 5849088.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.22896384E8
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"} 5242880.0
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 8.0830144E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 6053672.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1592704.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4960256.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8619904E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.0614976E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.829588E7
# EOF

查询参数

端点使用查询参数来限制返回的样本。 下表显示了支持的查询参数：

Parameter Description

includedNames

Restricts the samples to those that match the names. Optional.

获取过滤后的指标

要获取匹配特定名称的指标，向 /actuator/prometheus 发送 GET 请求，使用 includedNames 查询参数，如下面的基于 curl 的示例所示：

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

响应结果类似于以下内容：

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

# 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"} 4.4040192E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 9.3323264E7
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 6291456.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 5046272.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 2.1102592E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1075584E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.9364096E7
# 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"} 7340032.0
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 8.0830144E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 6053672.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1619968.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4964864.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8752768E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.0628184E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.8465848E7