Package io.sentry.spring7.tracing

Class SentryTracingFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

io.sentry.spring7.tracing.SentryTracingFilter

All Implemented Interfaces:

jakarta.servlet.Filter, Aware, BeanNameAware, DisposableBean, InitializingBean, EnvironmentAware, EnvironmentCapable, ServletContextAware

public class SentryTracingFilter
extends OncePerRequestFilter

Creates ITransaction around HTTP request executions if performance is enabled. Otherwise just reads tracing information from incoming request.

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	Description
SentryTracingFilter()	Creates filter that resolves transaction name using SpringMvcTransactionNameProvider.
SentryTracingFilter(@NotNull io.sentry.IScopes scopes)
SentryTracingFilter(@NotNull io.sentry.IScopes scopes, @NotNull TransactionNameProvider transactionNameProvider)	Creates filter that resolves transaction name using transaction name provider given by parameter.
SentryTracingFilter(@NotNull io.sentry.IScopes scopes, @NotNull TransactionNameProvider transactionNameProvider, boolean isAsyncSupportEnabled)	Creates filter that resolves transaction name using transaction name provider given by parameter.

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(@NotNull jakarta.servlet.http.HttpServletRequest httpRequest, @NotNull jakarta.servlet.http.HttpServletResponse httpResponse, @NotNull jakarta.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 Details

SentryTracingFilter

public SentryTracingFilter()

Creates filter that resolves transaction name using SpringMvcTransactionNameProvider.

Only requests that have HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE request attribute set are turned into transactions. This attribute is set in RequestMappingInfoHandlerMapping on request that have not been dropped with any Filter.

SentryTracingFilter

public SentryTracingFilter(@NotNull
 @NotNull io.sentry.IScopes scopes,
 @NotNull
 @NotNull TransactionNameProvider transactionNameProvider)

Creates filter that resolves transaction name using transaction name provider given by parameter.

Parameters:

scopes - - the scopes

transactionNameProvider - - transaction name provider.

SentryTracingFilter

public SentryTracingFilter(@NotNull
 @NotNull io.sentry.IScopes scopes,
 @NotNull
 @NotNull TransactionNameProvider transactionNameProvider,
 boolean isAsyncSupportEnabled)

Creates filter that resolves transaction name using transaction name provider given by parameter.

Parameters:

scopes - - the scopes

transactionNameProvider - - transaction name provider.

isAsyncSupportEnabled - - whether transactions should be kept open until async handling is done

SentryTracingFilter

public SentryTracingFilter(@NotNull
 @NotNull io.sentry.IScopes scopes)

Method Details

shouldNotFilterAsyncDispatch

protected boolean shouldNotFilterAsyncDispatch()

Overrides:

shouldNotFilterAsyncDispatch in class OncePerRequestFilter

doFilterInternal

protected void doFilterInternal(@NotNull
 @NotNull jakarta.servlet.http.HttpServletRequest httpRequest,
 @NotNull
 @NotNull jakarta.servlet.http.HttpServletResponse httpResponse,
 @NotNull
 @NotNull jakarta.servlet.FilterChain filterChain)
                         throws jakarta.servlet.ServletException,
IOException

Specified by:

doFilterInternal in class OncePerRequestFilter

Throws:

jakarta.servlet.ServletException

IOException