[Spring Boot 번역] Prometheus (prometheus)

출처: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/prometheus.html

---

이 버전은 아직 개발 중이며 안정적이지 않습니다. 최신 안정 버전은 Spring Boot 3.5.6을 사용하세요!

Prometheus (prometheus)

prometheus 엔드포인트는 Spring Boot 애플리케이션의 메트릭을 Prometheus 서버가 스크래핑하는 데 필요한 형식으로 제공합니다.

모든 메트릭 조회

모든 메트릭을 조회하려면 /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: 3083

# 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.5574528E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 7.5497472E7
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'"} 4325376.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9070976E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 9175040.0
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.093696E7
# 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"} 1.3631488E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.8565616E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4545184.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1777280.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3923584.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.6969216E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 8863200.0
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.022668E7

기본 응답 콘텐츠 타입은 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: 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.5574528E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 7.5497472E7
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'"} 4325376.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9070976E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 9175040.0
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.0740352E7
# 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"} 1.2582912E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.8565616E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4545184.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1776128.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3921280.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.6862464E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 8840088.0
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.0031904E7
# EOF

쿼리 파라미터

엔드포인트는 반환할 샘플을 제한하기 위해 쿼리 파라미터를 사용합니다.

다음 표는 지원되는 쿼리 파라미터를 보여줍니다:

파라미터	설명
includedNames	샘플을 이름과 일치하는 것으로 제한합니다. 선택 사항입니다.

필터링된 메트릭 조회

특정 이름과 일치하는 메트릭을 조회하려면 includedNames 쿼리 파라미터와 함께 /actuator/prometheus에 GET 요청을 수행합니다. 다음은 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: 1458

# 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.5574528E7
jvm_memory_committed_bytes{area="heap",id="G1 Old Gen"} 7.5497472E7
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'"} 4325376.0
jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.9070976E7
jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space"} 9175040.0
jvm_memory_committed_bytes{area="nonheap",id="Metaspace"} 8.1002496E7
# 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.4680064E7
jvm_memory_used_bytes{area="heap",id="G1 Old Gen"} 5.8565616E7
jvm_memory_used_bytes{area="heap",id="G1 Survivor Space"} 4545184.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'"} 1777280.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'"} 3929600.0
jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'"} 1.6991616E7
jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space"} 8863816.0
jvm_memory_used_bytes{area="nonheap",id="Metaspace"} 8.0234944E7

---

관련 링크

• Metrics (metrics)
• Quartz (quartz)