[SpringBoot] health check API(서버 상태 확인 api) 설정 방법

서버의 상태를 확인할 수 있는 health check API를 추가해보자.

 

1. dependency 추가

• spring-boot-actuator 모듈은 스프링 부트의 production-ready features의 모든 것을 제공한다.
•  Maven
  •  
  • <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> </dependencies>
• Gradle

  • dependencies {
        implementation 'org.springframework.boot:spring-boot-starter-actuator'
    }

 

2. Endpoints

• Acuator endpoints를 사용하여 애플리케이션을 모니터링하고 상호 작용할 수 있다.
• Spring boot에는 여러 가지 기본 제공 endpoints가 포함되어 있으며 이를 통해 자신만의 endpoint를 추가할 수 있다. 
• 예: health endpoint는 애플리케이션의 health 정보를 제공한다.
• 대부분의 애플리케이션은 /actuator 접두사와 함께 끝점의 ID가 URL에 매핑되는 HTTP를 통해 노출한다.
  • 예:  http://~~/actuator/health
• 설정 방법:
  • application.yaml에 다음의 코드를 추가

  • management:
      endpoints:
        web.exposure.include: "health,env"

  • health: 애플리케이션의 health 정보를 보여줌
  • env: 스프링의 ConfigurableEnvironment로부터 properties를 노출
  • include: * 를 통해 전부 사용한 후, exclude를 통해 일부만 제거 가능
  • jmx.exposure 사용 가능
• 자세한 사항과 endpoints에 대한 설명들은 하단의 출처 참고

 

 

 

 

 

 

출처

- Spring Boot Actuator: https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html