public class ServletFilterHeaderSpanDecorator extends Object implements ServletFilterSpanDecorator
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| Modifier and Type | Class and 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 |
STANDARD_TAGS| Constructor and 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
|
| Modifier and Type | Method and Description |
|---|---|
List<ServletFilterHeaderSpanDecorator.HeaderEntry> |
getAllowedHeaders() |
String |
getPrefix() |
void |
onError(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.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(javax.servlet.http.HttpServletRequest httpServletRequest,
io.opentracing.Span span)
Decorate span before
Filter.doFilter(ServletRequest, ServletResponse, FilterChain) is
called. |
void |
onResponse(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse,
io.opentracing.Span span)
Decorate span after
Filter.doFilter(ServletRequest, ServletResponse, FilterChain). |
void |
onTimeout(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse,
long timeout,
io.opentracing.Span span)
Decorate span on asynchronous request timeout.
|
public ServletFilterHeaderSpanDecorator(List<ServletFilterHeaderSpanDecorator.HeaderEntry> allowedHeaders)
allowedHeaders - list of ServletFilterHeaderSpanDecorator.HeaderEntry to extract from the incoming requestpublic ServletFilterHeaderSpanDecorator(List<ServletFilterHeaderSpanDecorator.HeaderEntry> allowedHeaders, String prefix)
allowedHeaders - list of ServletFilterHeaderSpanDecorator.HeaderEntry to extract from the incoming requestprefix - the prefix to prepend on each @StringTag. Can be null is not prefix is desiredpublic void onRequest(javax.servlet.http.HttpServletRequest httpServletRequest,
io.opentracing.Span span)
ServletFilterSpanDecoratorFilter.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.onRequest in interface ServletFilterSpanDecoratorhttpServletRequest - requestspan - span to decoratepublic void onResponse(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse,
io.opentracing.Span span)
ServletFilterSpanDecoratorFilter.doFilter(ServletRequest, ServletResponse, FilterChain). When it
is an async request this will be called in AsyncListener.onComplete(AsyncEvent).onResponse in interface ServletFilterSpanDecoratorhttpServletRequest - requesthttpServletResponse - responsespan - span to decoratepublic void onError(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse,
Throwable exception,
io.opentracing.Span span)
ServletFilterSpanDecoratorFilter.doFilter(ServletRequest, ServletResponse, FilterChain). This is
also called in AsyncListener.onError(AsyncEvent).onError in interface ServletFilterSpanDecoratorhttpServletRequest - requestexception - exceptionspan - span to decoratepublic void onTimeout(javax.servlet.http.HttpServletRequest httpServletRequest,
javax.servlet.http.HttpServletResponse httpServletResponse,
long timeout,
io.opentracing.Span span)
ServletFilterSpanDecoratorAsyncListener.onTimeout(AsyncEvent).onTimeout in interface ServletFilterSpanDecoratorhttpServletRequest - requesthttpServletResponse - responsetimeout - timeoutspan - span to decoratepublic String getPrefix()
public List<ServletFilterHeaderSpanDecorator.HeaderEntry> getAllowedHeaders()
Copyright © 2018–2022. All rights reserved.