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: 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"} 1.90840832E8
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.14294784E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 3145728.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3932160.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8415616E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1206656E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.897088E7
# 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.77209344E8
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 7.6726784E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 2954856.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1383552.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3870080.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.836544E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.082108E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.8197888E7

デフォルトのレスポンスコンテンツ型は 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: 3098

# 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"} 1.90840832E8
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.14294784E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 3145728.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3866624.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8284544E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1206656E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.8839808E7
# 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.75112192E8
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 7.6726784E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 2954856.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1383552.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3854464.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8262016E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.0808496E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.8051624E7
# EOF

クエリパラメーター

エンドポイントはクエリパラメーターを使用して、返されるサンプルを制限します。次の表は、サポートされているクエリパラメーターを示しています。

パラメーター 説明

includedNames

サンプルを名前と一致するものに制限します。オプション。

フィルタリングされたメトリクスの取得

特定の名前に一致するメトリクスを取得するには、次のカールベースの例に示すように、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"} 1.90840832E8
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 1.14294784E8
jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space"} 3145728.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 2555904.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3932160.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8415616E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 1.1206656E7
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 7.897088E7
# 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.7825792E8
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 7.6726784E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 2954856.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1383552.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3870848.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.8386304E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 1.082168E7
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 7.820596E7