[Spring Boot/RESTful] REST API Monitoring을 위한 Actuator(+spring fox PathPatternParser 이슈)

Actuator

현재 기동하고 있는 어플리케이션의 상태를 쉽게 monitoring할 수 있다.

현재 서버가 구동 중인지도 확인 가능 

기본 제공하는 링크를 별도로 커스터마이징해서 사용하면 더 좋다.

 

Actuator 구현

dependency 추가

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

에러

Actuator는 PathPatternParser를 사용하기 때문에 지난 Swagger 설정에서 허용해줬던 yml 설정으로는 해결되지 않는다.

org.springframework.context.ApplicationContextException: 
Failed to start bean 'documentationPluginsBootstrapper';

https://github.com/springfox/springfox/issues/3462

Spring 5.3/Spring Boot 2.4 support · Issue #3462 · springfox/springfox

spring fox에서 업데이트를 안 해서 생긴 버전 이슈로 아래 코드를 설정해주면 된다. 

SwaggerConfig.java 안에 bean 설정해주기
@Bean
public WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping
        (WebEndpointsSupplier webEndpointsSupplier, 
        ServletEndpointsSupplier servletEndpointsSupplier, 
        ControllerEndpointsSupplier controllerEndpointsSupplier, 
        EndpointMediaTypes endpointMediaTypes, 
        CorsEndpointProperties corsProperties, 
        WebEndpointProperties webEndpointProperties, 
        Environment environment) 
		{
	        List<ExposableEndpoint<?>> allEndpoints = new ArrayList();
	        Collection<ExposableWebEndpoint> webEndpoints = webEndpointsSupplier.getEndpoints();
	        allEndpoints.addAll(webEndpoints);
	        allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());
	        allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());
	        String basePath = webEndpointProperties.getBasePath();
	        EndpointMapping endpointMapping = new EndpointMapping(basePath);
	        boolean shouldRegisterLinksMapping = this.shouldRegisterLinksMapping(
            		webEndpointProperties, environment, basePath);
	        return new WebMvcEndpointHandlerMapping(
            		endpointMapping, webEndpoints, endpointMediaTypes, 
                    corsProperties.toCorsConfiguration(), 
                    new EndpointLinksResolver(allEndpoints, basePath), 
                    shouldRegisterLinksMapping, null);
	    }

	private boolean shouldRegisterLinksMapping(WebEndpointProperties webEndpointProperties,
   		 Environment environment, String basePath) 
         {
	        return webEndpointProperties.getDiscovery().isEnabled() 
            && (StringUtils.hasText(basePath) || 
            ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));
	    }

링크 접속

http://localhost:8088/actuator

http://localhost:8088/actuator/health → 서버가 작동 중인지 확인할 수 있다

 

application.yml 설정

조금 더 다양한 파일을 볼 수 있다.

# actuator 설정
management:
  endpoints:
    web:
      exposure:
        include: "*"