[Spring] Spring Actuator를 이용한 운영 어플리케이션 관리:: 세팅 및 Health check 테스트

Spring Actuator?
Dependency 추가
   - 정상상태(Health check) 점검 결과 확인
      1. 서버 상태 세부정보 표시

Spring Actuator?

💡 스프링 부트 애플리케이션의 다양한 운영 정보(health check, metrics, info 등)를 노출하는 엔드포인트를 제공하는 라이브러리입니다. 애플리케이션의 상태 모니터링, 운영 환경 필요 정보 확인.

Dependency 추가

💡 스프링 부트 엑츄에이터를 추가해 준다. 스프링 애플리케이션 재실행 시 아래와 같이 나오면 성공

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

2023-04-09 14:15:50.658  INFO 26768 --- [           main] o.s.b.a.e.web.EndpointLinksResolver      :
 Exposing 2 endpoint(s) **beneath base path '/actuator'**

정상상태(Health check) 점검 결과 확인

💡 `{{localhost}}/actuator/health` 를 확인하면 아무것도 만들지 않았어도 아래와 같은 JSON 값을 볼 수 있다. 해당 경로를 통해 Health check를 확인할 수 있다.

{
  "status": "UP"
}

서버 상태 세부정보 표시

💡 yml or properties 파일에 설정 추가, 이 글에서는 yml을 기준으로 설명, status 값 외에 세팅된 몽고디비 정보, 디스크 상태 및 용량 정보 등이 추가된다

management:
  endpoint:
    health:
      show-details: always

{
  "status": "UP",
  "components": {
    "diskSpace": {
      "status": "UP",
      "details": {
        "total": 498949857280,
        "free": 24393216000,
        "threshold": 10485760,
        "exists": true
      }
    },
    "mongo": {
      "status": "UP",
      "details": {
        "version": "3.5.5"
      }
    },
    "ping": {
      "status": "UP"
    }
  }
}