在Actuator(Springboot)中配置TraceFilter不起作用

时间:2017-11-03 10:43:20

标签: java filter trace spring-boot-actuator

我正在尝试在与主弹簧启动项目不同的jar中创建过滤器。其中一个是Actuator中的Trace过滤器(在调用 / trace 时执行的过滤器),我将其配置为不跟踪对 / trace 本身的调用。如果我在项目中定义过滤器,它可以很好地工作,并且不会跟踪对 / trace 的调用。

但是,当我将类提取到另一个库并从主项目引用它时,它正在跟踪这些调用。我已检查所有引用是否正确,并且正在执行过滤器。但是,我怀疑在初始化依赖项时,我的过滤器和WebRequestTraceFilter(我的过滤器中的类都是继承的)都被实例化了。这是Filter类:

package common.api.filters.trace;


import org.springframework.boot.actuate.trace.TraceProperties;
import org.springframework.boot.actuate.trace.TraceRepository;
import org.springframework.boot.actuate.trace.WebRequestTraceFilter;
import org.springframework.stereotype.Component;
import org.springframework.util.AntPathMatcher;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;

/**
 * Class to exclude some some endpoints to be traced such as /admin/**, * /trace and
 * endpoints provide static files like /css/** and /js/**.
 */
@Component
public class RequestTraceFilter extends WebRequestTraceFilter {

    private static final String[] excludedEndpoints = new String[]{"/css/**", "/js/**", "/trace"};

    public RequestTraceFilter(TraceRepository repository, TraceProperties properties) {
        super(repository, properties);
    }

    /*
        The default implementation was always returning false.
        With this implementation, it returns true for the endpoints we don’t want to trace.
     */
    @Override
    protected boolean shouldNotFilter(final HttpServletRequest request) throws ServletException {
        return Arrays
                .stream(excludedEndpoints)
                .anyMatch(e -> new AntPathMatcher().match(e, request.getServletPath()));
    }
}

我也尝试删除标记@Component并在用@Configuration标记的类中以这种方式初始化Filter:

@Bean
public FilterRegistrationBean createTraceFilter(){
    FilterRegistrationBean frb = new FilterRegistrationBean();
    frb.setFilter(new RequestTraceFilter(new InMemoryTraceRepository(), new TraceProperties()));
    return frb;
}

但结果是一样的:正在执行过滤器,但正在跟踪对/ trace的调用。

如何将主项目中的Filter初始化为跟踪时唯一执行的过滤器?

1 个答案:

答案 0 :(得分:0)

我已经发现了正在发生的事情:正如我想的那样,实例化了两个类:RequestTraceFilter和WebRequestTraceFilter。因此,我的执行正确,但是WebRequestTraceFilter也被执行并在shouldNotFilter方法中返回false,跟踪对/ trace本身的调用。我已经解决了它改变我以这种方式初始化依赖关系的方式:

@Bean
public WebRequestTraceFilter createTraceFilter(){
    return new RequestTraceFilter(new InMemoryTraceRepository(), new TraceProperties());
}

现在,当Spring引导问一个WebRequestTraceFilter的实例时,它只返回我的。