Prometheus (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"} 2.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"} 36864.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"} 36864.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"} 8.0740352E7
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 8388608.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4849664.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.867776E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.14688E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.0805888E7
# 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'"} 5832704.0
jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 1.22916864E8
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"} 5.0331648E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.947584E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 7746152.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1852416.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4786432.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.866752E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.1150008E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.0114352E7
默认的响应内容类型为 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"} 2.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"} 36864.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"} 36864.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"} 8.0740352E7
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 8388608.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4784128.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.867776E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1403264E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.0543744E7
# 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'"} 5832704.0
jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 1.22916864E8
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"} 4.8234496E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.947584E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 7746152.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1851264.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4782592.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8627456E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.112792E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.9915232E7
# EOF
查询参数
该端点使用查询参数来限制返回的样本。下表列出了支持的查询参数:
| 参数 | 描述 |
|---|---|
includedNames | 限制样本仅包含匹配名称的样本。可选。 |
获取过滤后的指标
要检索匹配特定名称的指标,请向 /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: 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"} 8.0740352E7
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 8388608.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4849664.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8743296E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.14688E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.0805888E7
# 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"} 5.1380224E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.947584E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 7746152.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1852416.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 4789504.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8705024E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.1150616E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.0136328E7