Spring Actuator 사용해보기

Spring Actuator란? 

애플리케이션의 상태를 모니터링, Metric 수집을 위한 Http Endpoint를 제공해주는 모듈이다. 

(요약하면 애플리케이션의 상태를 전체적으로 알 수 있도록 도와주는 기능!)

 

    // https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-actuator
    implementation 'org.springframework.boot:spring-boot-starter-actuator:3.0.1'

다음과 같이 dependency만 추가해주면 사용이 가능하다. 

 

Ex) spring 설정 yaml 파일에 아래와 같이 어떤 endpoint들을 포함할지 명시해주면 된다. 

management:
  endpoints:
    web:
      exposure:
        include: refresh,health,beans,httpexchanges

 

주요 엔드 포인트 종류

beans 

- 애플리케이션의 모든 Spring Bean 목록을 표시해준다. 

- http://localhost:8080/actuator/beans

 

health (주로 사용하는 endpoint)

- 애플리케이션의 현재 상태 정보를 표시한다.

- http://localhost:8080/actuator/health

 

httpexchanges(httptrace)

- 최근 100개의 http 요청을 반환한다.

management.trace.http.include=request-headers,response-headers,cookies,errors

노출 시 포함시킬 관련 요소들을 지정할 수 있다.

@Bean
public InMemoryHttpExchangeRepository createTraceRepository() {
    return new InMemoryHttpExchangeRepository();
}

빈으로 InMemoryHttpExchangeRepository를 등록해주어야 한다. 

- http://localhost:8080/actuator/httpexchanges

 

env

- 스프링의 모든 환경변수 정보를 표시 (보안상 비추천)

- management.endpoint.env.keys-to-sanitize 속성을 통해 민감한 속성을 가릴 수 있다.

- http://localhost:8080/actuator/env

 

metrics

- 애플리케이션의 각종 지표를 제시한다. (CPU 사용률, 커넥션풀..) 

- http://localhost:8080/actuator/metrics

- cpu 사용률 확인

http://localhost:8080/actuator/metrics/process.cpu.usage

 

conditions

- 스프링 자동 configuration 과 직접 설정한 configuration class들의 성공 여부와 이유를 설명한다. 

- http://localhost:8080/actuator/conditions

 

refresh

- 애플리케이션의 설정 정보를 refresh 할 수 있다.

- [POST] http://localhost:8080/actuator/refresh

 

그 외에도 공식 문서를 보면 다양한 API 들을 확인할 수 있다. 

https://docs.spring.io/spring-boot/docs/3.0.x/actuator-api/htmlsingle/#httpexchanges

Spring Boot Actuator Web API Documentation

 

actuator는 개발자에게는 편의를 주지만 보안상 문제로 안전하게 사용할 필요가 있다. 

 

Spring Actuator 안전하게 사용하는 방법

• management.endpoints.enabled-by-default  속성을 false로 하여 모든 endpoint에 대해 disable 상태를 유지하고 운영상 필요한 endpoint만 true로 설정하자.
• actuator endpoint는 enable시킨다고 바로 사용할 수 있는 것이 아니라 expose에 명시해주어야 하는데 expose에 Include할 때, aterisk(*)가 아닌 필요한 endpoint만 명시해주도록 하자.

       ex) management.endpoints.web.exposure.include=health,httpexchanges

•  acutator 접근할 때에는 인증이 된 권한이 있는 사용자만 접근 가능하도록 하자. 
• acutator는 서비스 운영에 사용되는 포트와 다른 포트를 사용한다.
• acutator default 경로를 사용하지 않고, 경로를 변경하여 운영한다.

참고

https://techblog.woowahan.com/9232/

Security Actuator 안전하게 사용하기 | 우아한형제들 기술블로그