org.springframework.boot.actuate.metrics.web.servlet

Class WebMvcMetricsFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.boot.actuate.metrics.web.servlet.WebMvcMetricsFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public class WebMvcMetricsFilter
extends org.springframework.web.filter.OncePerRequestFilter

Intercepts incoming HTTP requests and records metrics about Spring MVC execution time and results.

Since:

2.0.0

Author:

Jon Schneider, Phillip Webb

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor and Description
WebMvcMetricsFilter(io.micrometer.core.instrument.MeterRegistry registry, WebMvcTagsProvider tagsProvider, String metricName, AutoTimer autoTimer) Create a new WebMvcMetricsFilter instance.
WebMvcMetricsFilter(io.micrometer.core.instrument.MeterRegistry registry, WebMvcTagsProvider tagsProvider, String metricName, boolean autoTimeRequests) Deprecated. since 2.2.0 in favor of WebMvcMetricsFilter(MeterRegistry, WebMvcTagsProvider, String, AutoTimer)

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)
protected boolean	shouldNotFilterAsyncDispatch()

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebMvcMetricsFilter

@Deprecated
public WebMvcMetricsFilter(io.micrometer.core.instrument.MeterRegistry registry,
                                       WebMvcTagsProvider tagsProvider,
                                       String metricName,
                                       boolean autoTimeRequests)

Deprecated. since 2.2.0 in favor of WebMvcMetricsFilter(MeterRegistry, WebMvcTagsProvider, String, AutoTimer)

Create a new WebMvcMetricsFilter instance.

Parameters:

registry - the meter registry

tagsProvider - the tags provider

metricName - the metric name

autoTimeRequests - if requests should be automatically timed

Since:

2.0.7

WebMvcMetricsFilter

public WebMvcMetricsFilter(io.micrometer.core.instrument.MeterRegistry registry,
                           WebMvcTagsProvider tagsProvider,
                           String metricName,
                           AutoTimer autoTimer)

Create a new WebMvcMetricsFilter instance.

Parameters:

registry - the meter registry

tagsProvider - the tags provider

metricName - the metric name

autoTimer - the auto-timers to apply or null to disable auto-timing

Since:

2.2.0

Method Detail

shouldNotFilterAsyncDispatch

protected boolean shouldNotFilterAsyncDispatch()

Overrides:

shouldNotFilterAsyncDispatch in class org.springframework.web.filter.OncePerRequestFilter

doFilterInternal

protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

javax.servlet.ServletException

IOException