Package io.smallrye.opentracing.contrib.web.servlet.filter.decorator

Class ServletFilterHeaderSpanDecorator

java.lang.Object

io.smallrye.opentracing.contrib.web.servlet.filter.decorator.ServletFilterHeaderSpanDecorator

All Implemented Interfaces:

ServletFilterSpanDecorator

public class ServletFilterHeaderSpanDecorator
extends Object
implements ServletFilterSpanDecorator

ServletFilterHeaderSpanDecorator will decorate the span based on incoming HTTP headers. Incoming are compared to the list of allowedHeaders, if the header is part of the provided list, they will be added as StringTag. The tag format will be a concatenation of prefix and ServletFilterHeaderSpanDecorator.HeaderEntry.tag

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServletFilterHeaderSpanDecorator.HeaderEntry	HeaderEntry is used to configure ServletFilterHeaderSpanDecorator ServletFilterHeaderSpanDecorator.HeaderEntry.header is used to check if the header exists using HttpServletRequest.getHeader(String) ServletFilterHeaderSpanDecorator.HeaderEntry.tag will be used as a StringTag if ServletFilterHeaderSpanDecorator.HeaderEntry.header is found on the incoming request

Field Summary

Fields inherited from interface io.smallrye.opentracing.contrib.web.servlet.filter.ServletFilterSpanDecorator

STANDARD_TAGS

Constructor Summary

Constructors

Constructor	Description
ServletFilterHeaderSpanDecorator(List<ServletFilterHeaderSpanDecorator.HeaderEntry> allowedHeaders)	Constructor of ServletFilterHeaderSpanDecorator with a default prefix of "http.header."
ServletFilterHeaderSpanDecorator(List<ServletFilterHeaderSpanDecorator.HeaderEntry> allowedHeaders, String prefix)	Constructor of ServletFilterHeaderSpanDecorator

Method Summary

Modifier and Type	Method	Description
List<ServletFilterHeaderSpanDecorator.HeaderEntry>	getAllowedHeaders()
String	getPrefix()
void	onError(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse, Throwable exception, io.opentracing.Span span)	Decorate span when an exception is thrown during processing in Filter.doFilter(ServletRequest, ServletResponse, FilterChain).
void	onRequest(jakarta.servlet.http.HttpServletRequest httpServletRequest, io.opentracing.Span span)	Decorate span before Filter.doFilter(ServletRequest, ServletResponse, FilterChain) is called.
void	onResponse(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse, io.opentracing.Span span)	Decorate span after Filter.doFilter(ServletRequest, ServletResponse, FilterChain).
void	onTimeout(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse, long timeout, io.opentracing.Span span)	Decorate span on asynchronous request timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletFilterHeaderSpanDecorator

public ServletFilterHeaderSpanDecorator(List<ServletFilterHeaderSpanDecorator.HeaderEntry> allowedHeaders)

Constructor of ServletFilterHeaderSpanDecorator with a default prefix of "http.header."

Parameters:

allowedHeaders - list of ServletFilterHeaderSpanDecorator.HeaderEntry to extract from the incoming request

ServletFilterHeaderSpanDecorator

public ServletFilterHeaderSpanDecorator(List<ServletFilterHeaderSpanDecorator.HeaderEntry> allowedHeaders,
                                        String prefix)

Constructor of ServletFilterHeaderSpanDecorator

Parameters:

allowedHeaders - list of ServletFilterHeaderSpanDecorator.HeaderEntry to extract from the incoming request

prefix - the prefix to prepend on each @StringTag. Can be null is not prefix is desired

Method Detail

onRequest

public void onRequest(jakarta.servlet.http.HttpServletRequest httpServletRequest,
                      io.opentracing.Span span)

Description copied from interface: ServletFilterSpanDecorator

Decorate span before Filter.doFilter(ServletRequest, ServletResponse, FilterChain) is called. This is called right after span in created. Span is already present in request attributes with name TracingFilter.SERVER_SPAN_CONTEXT.

Specified by:

onRequest in interface ServletFilterSpanDecorator

Parameters:

httpServletRequest - request

span - span to decorate

onResponse

public void onResponse(jakarta.servlet.http.HttpServletRequest httpServletRequest,
                       jakarta.servlet.http.HttpServletResponse httpServletResponse,
                       io.opentracing.Span span)

Description copied from interface: ServletFilterSpanDecorator

Decorate span after Filter.doFilter(ServletRequest, ServletResponse, FilterChain). When it is an async request this will be called in AsyncListener.onComplete(AsyncEvent).

Specified by:

onResponse in interface ServletFilterSpanDecorator

Parameters:

httpServletRequest - request

httpServletResponse - response

span - span to decorate

onError

public void onError(jakarta.servlet.http.HttpServletRequest httpServletRequest,
                    jakarta.servlet.http.HttpServletResponse httpServletResponse,
                    Throwable exception,
                    io.opentracing.Span span)

Description copied from interface: ServletFilterSpanDecorator

Decorate span when an exception is thrown during processing in Filter.doFilter(ServletRequest, ServletResponse, FilterChain). This is also called in AsyncListener.onError(AsyncEvent).

Specified by:

onError in interface ServletFilterSpanDecorator

Parameters:

httpServletRequest - request

exception - exception

span - span to decorate

onTimeout

public void onTimeout(jakarta.servlet.http.HttpServletRequest httpServletRequest,
                      jakarta.servlet.http.HttpServletResponse httpServletResponse,
                      long timeout,
                      io.opentracing.Span span)

Description copied from interface: ServletFilterSpanDecorator

Decorate span on asynchronous request timeout. It is called in AsyncListener.onTimeout(AsyncEvent).

Specified by:

onTimeout in interface ServletFilterSpanDecorator

Parameters:

httpServletRequest - request

httpServletResponse - response

timeout - timeout

span - span to decorate

getPrefix

public String getPrefix()

getAllowedHeaders

public List<ServletFilterHeaderSpanDecorator.HeaderEntry> getAllowedHeaders()