스프링부트 Actuator

 

 

1️⃣ Spring Actuator 

실무에서는 개발을 한다 하면 요구사항대로 개발을 하는 것을 넘어서 만든 서비스에 문제가 있는지 없는지 모니터링하고 지표들을 심어서 감시하는 활동이 필요하다. 

이런 활동을 프로덕션 준비 기능이라고 하는데 프로덕션을 운영에 배포할 때 준비해야하는 비 기능적인 요소들을 뜻한다. 

 

- 지표 metric, 추적 trace, 감사 auditing 

- 모니터링 

 

애플리케이션이 현재 살아있는지, 로그 정보는 정상적으로 설정되어 있는지, 커넥션 풀은 얼마나 사용되고 있는 지 등을 확인할 수 있어야 하는데 스프링 부트는 actuator라는 걸 제공해 프로덕션 준비 기능을 편리하게 사용할 수 있도록 도와준다. 

 

Spring Actuator는 운영중인 애플리케이션을 HTTP나 JMX 를 이용해서 모니터링하고 관리할 수 있는 기능을 제공한다. 

 

 

 

2️⃣ Actuator 사용법 

스프링이 제공하는 액츄에이터를 사용하기 위해서는 라이브러리를 추가해야한다. 

implementation 'org.springframework.boot:spring-boot-starter-actuator' //actuator 추가

build.gradle에 액츄에이터 라이브러리를 추가한다. 

 

라이브러리를 추가하고 애플리케이션을 실행한 다음 

localhost:8080/actuator 

를 실행하면 

/actuator는 사용가능한 앤드포인트 목록을 확인할 수 있다. 

endpoints 란 모니터링이나 조작을 할 수 있도록 하는 연결점으로 기본 endpoints 를 제공하고 사용자가 필요에 따라 추가할 수도 있다. 

 

/actuator/health를 보면 

이 기능은 현재 서버가 잘 동작하고 잇는지 애플리케이션의 헬스 상태를 나타내는 것이다. 

(기본 설정은 이렇게 현재 상태만 확인할 수 있도록 되어 있고 더 많은 기능을 보기 위해서는 노출 설정이 필요하다.) 

 

 

management:
  endpoints:
    web:
      exposure:
        include: "*"

더 많은 액츄에이터 기능을 웹에 노출시키기 위해서는 application.yml에 설정해주면 되고, 

그 다음 /actuator 를 하면 

액츄에이터가 제공하는 많은 기능을 확인할 수 있다. 

이렇게 액츄에이터가 제공하는 기능을 endpoint 라고 하는 것이다.

 

health : 애플리케이션 상태 

metrics : 메모리, 스레드 상태 등 

logger : logger 정보를 보고, logger level 상태 변경 등

beans : 스프링 컨테이너에 등록된 빈 조회 

 

 

 

3️⃣ Acuator Endpoint 설정 

endpoint를 사용하려면 2가지 설정이 필요하다.

 

- 앤드포인트 활성화 

- 앤드포인트 노출 

 

-> 앤드포인트를 활성화한다는 것은 해당 기능 자체를 사용할지 말지 on, off를 결정하는 것이고, 

앤드포인트를 노출한다는 것은 앤드포인트를 HTTP 에 노출할지 아니면 JMX에 노출할지 선택하는 것이다. 

(근데 앤드포인트가 활성화되지 않으면 노출 여부를 결정해도 보이지 않는다.) 

 

대부분의 앤드포인트는 활성화되어있고, 노출할지만 선택하면 된다.(shutdown 제외) 

 

management:
  endpoints:
    web:
      exposure:
        include: "*"

이 옵션은 모든 앤드포인트를 웹에 노출한다는 뜻이고, 이때 shutdown 앤드포인트는 일단 활성화 자체가 안되어 있기 때문에 노출도 되지 않는다. 

 

만약 shutdown 앤드포인트를 활성화하려면 

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    shutdown:
      enabled: true

management.endpoint.shutdown.enabled 를 true로 설정해주면 된다. 

localhost:8080/actuator/shutdown 을 POST로 요청하면 실제 서버가 종료되는 것을 확인할 수 있다. 

 

( 이 기능은 실제 서버가 종료되는 것이기 때문에  주의해서 사용해야 한다..!!) 

 

 

 

4️⃣ Endpoint 종류 

이렇게 각각 앤드포인트를 통해서 애플리케이션의 수 많은 기능을 관리하고 모니터링할 수 있다. 

 

Endpoint 종류 

- beans : 스프링 컨테이너에 등록된 스프링 빈을 보여준다. 

 

- conditions : condition을 통해서 빈을 등록할 때 평가 조건과 일치하거나 일치하지 않는 이유를 표시한다. 

 

 

- configprops : @ConfigurationProperties 를 보여준다. 

 

 

- env: Environment 정보를 보여준다. 

 

 

- health : 애플리케이션 헬스 정보를 보여준다. 

 

 

- httpexchanges : HTTP 호출 응답 정보를 보여준다. -> HttpExchangeRepository를 구현한 빈을 별도로 등록해야 사용 가능 

- info : 애플리케이션 정보를 보여준다. 

- loggers : 애플리케이션 로거 설정을 보여주고 변경할 수 있다. 

- metrics : 애플리케이션의 메트릭 정보를 보여준다. 

- mappings : @RequestMapping 정보를 보여준다. 

- threaddump : 쓰레드 덤프를 실행해서 보여준다. 

- shutdown : 애플리케이션을 종료한다. (기본: 비활성화)