How to disable interceptor call for Actuators in Springboot application

Question

I am trying to implement Prometheus in my microservices based spring boot application, deployed over weblogic server. As part of POC,I have included the configs as part of one war. To enable it, i have set below config -

Application.properties

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

Gradle -

    implementation 'io.micrometer:micrometer-registry-prometheus'

But the actuator request is getting blocked by existing interceptors. It asks to pass values in headers specific to our project. Through postman(http:localhost:8080/abc/actuator/prometheus), I am able to test my POC(with required headers) and it returns time-series data expected by Prometheus. But Prometheus is not able to scrap data on its own(with pull approach), as the call lacks headers in request.

I tried following links (link1,link2) to bypass it, but my request still got intercepted by existing interceptor. Interceptors blocking the request are part of dependent jars.

Edited -- I have used following way to exclude all calls to interceptor -

 @Configuration
 public class MyConfig implements WebMvcConfigurer{

@Override
public void addInterceptors(InterceptorRegistry registry){
    registry.addInterceptor(new MyCustomInterceptor()).addPathPatterns("**/actuator/**");
}

}

MyCustomInterceptor

@Component
 public class MyCustomInterceptor implements HandlerInterceptor{

  }

I have not implemented anything custom in MyCustomInterceptor(as i only want to exclude all calls to 'actuator' endpoint from other interceptors).

you can exclude PathPatterns from interceptor definitions. You just added new interceptor to chain — Gurkan İlleez, Mar 28 '22 at 06:59
I tried both the approaches i.e. excludePathPatterns("**/actuator/**"); and .addPathPatterns("**/actuator/**"); , but none worked — Narendra Pandey, Mar 28 '22 at 08:09
Actually actuator interceptors and your interceptors must be different but you can reconfigure by simply extending WebMvcEndpointManagementContextConfiguration — Gurkan İlleez, Mar 28 '22 at 08:14

score 0 · Answer 1 · answered Mar 28 '22 at 08:17

@Configuration
public class ActuatorConfig extends WebMvcEndpointManagementContextConfiguration {

  public WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping(WebAnnotationEndpointDiscoverer endpointDiscoverer,
                                                                       EndpointMediaTypes endpointMediaTypes,
                                                                       CorsEndpointProperties corsProperties,
                                                                       WebEndpointProperties webEndpointProperties) {
    WebMvcEndpointHandlerMapping mapping = super.webEndpointServletHandlerMapping(
      endpointDiscoverer,
      endpointMediaTypes,
      corsProperties,
      webEndpointProperties);

    mapping.setInterceptors(null);

    return mapping;
  }
}

Maybe you can override with setting null. I got code from https://github.com/spring-projects/spring-boot/issues/11234

WebAnnotationEndpointDiscoverer is not part of the actuator version i am in. Do we have any better subtle solution for it — Narendra Pandey, Mar 28 '22 at 19:06

score 0 · Answer 2 · answered Jun 03 '22 at 13:39

0

AFAIK Spring HandlerInterceptor do not intercept actuator's endpoints by default. Spring Boot can't intercept actuator access

answered Jun 03 '22 at 13:39

Oleg Kuts

769
1
13
26

How to disable interceptor call for Actuators in Springboot application

2 Answers2