Class OcHttpServletFilter
java.lang.Object
io.opencensus.contrib.http.servlet.OcHttpServletFilter
- All Implemented Interfaces:
javax.servlet.Filter
This filter class implements Filter interface called by web container. The filter is used as an
interceptor to enable tracing of http requests.
- Since:
- 0.19
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final String
(package private) static final TextFormat.Getter
<javax.servlet.http.HttpServletRequest> (package private) HttpServerHandler
<javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpServletRequest> static final String
Set optional OC_EXTRACTOR attribute inServletContext
withHttpExtractor
customExtractor.static final String
Set optional OC_PUBLIC_ENDPOINT attribute inServletContext
withBoolean
publicEndpoint.static final String
Set optional OC_TRACE_PROPAGATOR attribute inServletContext
withTextFormat
propagator. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) static HttpServerHandler
<javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpServletRequest> (package private) static HttpServerHandler
<javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpServletRequest> buildHttpServerHandlerWithOptions
(HttpExtractor<javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse> extractor, TextFormat propagator, Boolean publicEndpoint) void
destroy()
void
doFilter
(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) void
init
(javax.servlet.FilterConfig filterConfig)
-
Field Details
-
OC_TRACE_PROPAGATOR
Set optional OC_TRACE_PROPAGATOR attribute inServletContext
withTextFormat
propagator. By defaultTraceContextFormat
is used to propagate trace context.- Since:
- 0.20
- See Also:
-
OC_EXTRACTOR
Set optional OC_EXTRACTOR attribute inServletContext
withHttpExtractor
customExtractor. Default extractor is used if custom extractor is not provided.- Since:
- 0.20
- See Also:
-
OC_PUBLIC_ENDPOINT
Set optional OC_PUBLIC_ENDPOINT attribute inServletContext
withBoolean
publicEndpoint. set to true for publicly accessible HTTP(S) server. If true then incoming * tracecontext will be added as a link instead of as a parent. By default it is set to true.- Since:
- 0.20
- See Also:
-
EXCEPTION_MESSAGE
- See Also:
-
getter
-
handler
HttpServerHandler<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse, handlerjavax.servlet.http.HttpServletRequest>
-
-
Constructor Details
-
OcHttpServletFilter
public OcHttpServletFilter()Creates a newOcHttpServletFilter
.
-
-
Method Details
-
buildHttpServerHandler
static HttpServerHandler<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse, buildHttpServerHandler()javax.servlet.http.HttpServletRequest> -
buildHttpServerHandlerWithOptions
static HttpServerHandler<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse, buildHttpServerHandlerWithOptionsjavax.servlet.http.HttpServletRequest> (HttpExtractor<javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse> extractor, TextFormat propagator, Boolean publicEndpoint) -
init
public void init(javax.servlet.FilterConfig filterConfig) throws javax.servlet.ServletException - Specified by:
init
in interfacejavax.servlet.Filter
- Throws:
javax.servlet.ServletException
-
doFilter
public void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) throws IOException, javax.servlet.ServletException - Specified by:
doFilter
in interfacejavax.servlet.Filter
- Throws:
IOException
javax.servlet.ServletException
-
destroy
public void destroy()- Specified by:
destroy
in interfacejavax.servlet.Filter
-