このバージョンはまだ開発中であり、まだ安定しているとは見なされていません。最新の安定バージョンについては、Spring Boot 4.1.1 を使用してください！ |
Prometheus (prometheus)
prometheus エンドポイントは、Spring Boot アプリケーションのメトリクスを、Prometheus サーバーによるスクレイピングに必要な形式で提供します。
すべてのメトリクスの取得
すべてのメトリクスを取得するには、次の curl ベースの例に示すように、GET リクエストを /actuator/prometheus に送信します。
$ 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: 3086
# 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"} 5.1380224E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 6.815744E7
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'"} 3276800.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.5925248E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1206656E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.8053376E7
# 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'"} 5828608.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.22916864E8
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"} 2.2020096E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.5528928E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4796432.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1856256.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3174656.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.58624E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.0878648E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.7336208E7 デフォルトのレスポンスコンテンツ型は text/plain;version=0.0.4 です。次のカールベースの例に示すように、適切な Accept ヘッダーを使用して呼び出された場合、エンドポイントは application/openmetrics-text;version=1.0.0 を生成することもできます。
$ 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: 3091
# 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"} 5.1380224E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 6.815744E7
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'"} 3276800.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.5859712E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.114112E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.7725696E7
# 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'"} 5828608.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.22916864E8
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.9922944E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.5528928E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4796432.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1853952.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3172352.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.582464E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.0851216E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.709696E7
# EOFフィルタリングされたメトリクスの取得
特定の名前に一致するメトリクスを取得するには、次のカールベースの例に示すように、includedNames クエリパラメーターを使用して GET リクエストを /actuator/prometheus に送信します。
$ 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: 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"} 5.1380224E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 6.815744E7
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'"} 3276800.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.5925248E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1206656E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.8118912E7
# 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"} 2.2020096E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.5528928E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4796432.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1856256.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3215744.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.5880064E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.0879256E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.7346336E7
