스프링 Actuator Endpoint (health, info, logger, httpexchanges)

 

스프링부트 Actuator (tistory.com)

스프링부트 Actuator

저번 글에서 스프링 액츄에이터, 사용 방법, 설정하는 방법 등에 대해서 배웠다. 

그리고 마지막에 스프링부트가 제공하는 다양한 앤드포인트에 대해서 종류를 봤는데 그 중 자주? 사용하는 것들을 알아볼 것이다. 

 

 

1️⃣ health 

health 정보를 사용하면 애플리케이션에서 문제가 발생했을 때 문제를 좀 더 빠르게 인지할 수 있다. 

http://localhost:8080/actuator/health 

아무 설정 없이 health 를 보면 단순히 애플리케이션이 동작하는지 상태만 확인할 수 있다. 

추가로 설정하면 애플리케이션이 사용하는 데이터베이스가 응답하는지, 디스크 사용량은 문제가 없는지 등의 정보를 포함해서 확인할 수 있다. 

 

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    shutdown:
      enabled: true
    health:
      show-details: always

management.endpoint.health.show-details 를 always로 설정해주면 헬스 정보를 좀 더 자세히 확인할 수 있다. 

 

-> 이렇게 각각의 항목이 자세하게 노출되는데 이렇게 노출되는게 부담스럽다면 show-detail 옵션은 끄고 show-components 옵션을 키면 된다.  그러면 밑에 상세한 정보는 안나오고 status 정도만 나타나게 된다. 

 

 

* 그리고 이때 헬스 컴포넌트 중에 하나라도 문제가 있다면 전체 상태는 DOWN이 된다. 

 

 

 

2️⃣ info 

info 는 애플리케이션의 기본 정보를 노출한다. 

 

기본으로 제공하는 정보들로는 

- java  : 자바 런타임 정보 

- os : OS 정보 

- env : Environment 에서 info 로  시작하는 정보 

- build : 빌드 정보 -> META-INF/build-info.properties 파일 필요 

- git : git 정보 -> git.properties 파일 필요 

 

그리고 이때 java, os, env 는 비활성화 되어 있기 때문에 확인하려면 활성화해줘야 한다. 

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    shutdown:
      enabled: true
    health:
      show-details: always
  info:
    java:
      enabled: true
    os:
      enabled: true
    env:
      enabled: true

 management.info.java, os, env 를 true로 설정해주면 활성화된다. 

 

그리고 /actuator/info 하면 java, os, env 정보를 확인할 수 있다. 

build 정보를 노출하려면 META-INF/build-info.properties파일이 필요한데 

springBoot {
    buildInfo()
}

build.gradle에 위에 코드를 추가하고 build 해주면 파일이 생성된다. 

 

그리고 git 정보를 노출하려면 git.properties 파일이 필요하고, 

id "com.gorylenko.gradle-git-properties" version "2.4.1" //git info

build.gradle에 plugin으로 이걸 추가해줘야 한다. 

(그리고 당연한건데 해당 프로젝트가 깃으로 관리되고 있어야 한다.) 

 

 

 

3️⃣ logger 

logger 앤드포인트를 사용하면 로깅과 관련된 정보를 확인하고, 또 실시간으로 logging level을 변경할 수 있다. 

 

LogController 

@Slf4j
@RestController
public class LogController
{
   
   @GetMapping("/log")
   public String log()
   {
      log.trace("trace log");
      log.debug("debug log");
      log.info("info log");
      log.warn("warn log");
      log.error("error log");
      
      return "ok";
   }
}

 

application.yml

logging:
  level:
    hello.controller: debug

applicationi.yml에 hello.controller 패키지 포함 하위 패키지는 debug 레벨로 출력하도록 했다. 

 

그 다음 http://localhost:8080/log 하면 

debug 레벨까지 출력되는 것을 확인할 수 있다. 

 

http://localhost:8080/actuator/loggers 를 하면 

이렇게 로깅과 관련된  정보를 확인할 수 있고, 

우리가 설정한 LogController는 레벨이 debug인 것을 확인할 수 있다. (별도 설정 없으면 info가 기본) 

 

 

그리고 더 자세히 

http://localhost:8080/actuator/loggers/hello.controller

{로거 이름} 으로 조회하면 좀 더 자세하게 조회할 수 있다. 

 

 

* 실시간 로그 레벨 변경 

그리고 loggers 앤드포인트는 애플리케이션을 다시 시작하지 않고 실시간으로 로그 레벨을 변경할 수도 있다.  

 

http://localhost:8080/actuator/loggers/{로거이름} 을 POST로 요청하고 

configuredLevel을 원하는 레벨로 지정해서 요청하고, 요청 성공하면 204 응답이 온다. 

 

 

 

 

 

4️⃣ HTTP 요청 응답 기록 : httpexchanges 

httpexchanges 앤드포인트를 통해서 HTTP 요청과 응답의 과거 기록을 확인할 수 있다. 

 

HttpExchangeRepository 인터페이스의 구현체를 빈으로 등록하면 httpexchanges 앤드포인트를 사용할 수 있다. 

(스프링 부트는 기본으로 InMemoryHttpExchangeRepository 구현체를 제공) 

 

 

@SpringBootApplication
public class ActuatorApplication {

    public static void main(String[] args) {
        SpringApplication.run(ActuatorApplication.class, args);
    }
    
    @Bean
    public InMemoryHttpExchangeRepository httpExchangeRepository()
    {
        return new InMemoryHttpExchangeRepository();
    }

}

InMemoryHttpExchangeRepository를 빈으로 등록해준 다음 

 

http://localhost:8080/actuator/httpexchanges 실행해보면 

지금까지 실행했던 HTTP 요청과 응답 정보를 확인할 수 있다.

(우리가 요청했던 /log 도 있는 것을 확인할 수 있다. )

 

* 근데 httpexchanges 는 매우 단순하고 기능에 제한이 많기 때문에 개발 단계에서만 사용하고, 

실제 운영 서비스에서는 모니터링 툴이나 핀포인트, Zipkin 같은 기술을 사용하는 것이 좋다고 한다. 

 

 

 

5️⃣ 액츄에이터와 보안 

보면 액츄에이터는 편리하게 애플리케이션 상태 등을 확인할 수 있지만, 애플리케이션 내부 정보를 너무 많이 노출하게 된다. 

그래서 공개된 곳에 액츄에이터의 앤드 포인트들을 공개하는 것은 좋지 않다. 

 

-> 액츄에이터의 앤드포인트들은 외부 인터넷에서 접근이 불가능하게 막고, 내부에서만 접근 가능한 내부망을 사용하는 것이 안전하다. 

 

* 액츄에이터를 다른 포트에서 실행 

management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    shutdown:
      enabled: true
    health:
      show-details: always
  info:
    java:
      enabled: true
    os:
      enabled: true
    env:
      enabled: true
  server:
    port: 9292

management.server.port = 9292 로 설정해서 액츄에이터 기능을 사용하려면 애플리케이션 서버와는 다른 포트에서 실행하도록 설정해줄 수 있다. 

 

 

* 액츄에이터 URL 경로에 인증 설정 

위에 방법처럼 포트로 분리하는 것이 어렵다면 /actuator 경로에 서블릿 필터 또는 스프링 인터셉터, 스프링 시큐리티를 통해서 인증된 사용자만 접근하고 사용할 수 있도록 추가 개발이 필요하다. 

 

 

* 앤드포인트 경로 변경 

/actuator 경로 대신에 기본 경로를 변경해서 사용하는 방법도 있다. 

management.endpoints.web.base-path = "" 로 설정하면 경로를 변경할 수도 있다.