Class JaxrsContainerFilter

java.lang.Object

io.opencensus.contrib.http.jaxrs.JaxrsContainerFilter

All Implemented Interfaces:

javax.ws.rs.container.ContainerRequestFilter, javax.ws.rs.container.ContainerResponseFilter

@Provider
@Priority(4900)
public class JaxrsContainerFilter
extends Object
implements javax.ws.rs.container.ContainerRequestFilter, javax.ws.rs.container.ContainerResponseFilter

JAX-RS request and response filter to provide instrumentation of JAX-RS based endpoint with OpenCensus. Filter will instrument any endpoint marked with the Metrics annotation. Filter will also start a scoped span so that child spans may be added.

Since:

0.19

Constructor Summary

Constructors

Constructor	Description
JaxrsContainerFilter()	Default constructor construct new instance with JaxrsContainerExtractor, PropagationComponent.getTraceContextFormat() and as public endpoint.
JaxrsContainerFilter(HttpExtractor<io.opencensus.contrib.http.jaxrs.ExtendedContainerRequest, javax.ws.rs.container.ContainerResponseContext> extractor, TextFormat propagationFormat, Boolean publicEndpoint)	Construct instance with custom configuration.

Method Summary

Modifier and Type	Method	Description
void	filter(javax.ws.rs.container.ContainerRequestContext requestContext)
void	filter(javax.ws.rs.container.ContainerRequestContext requestContext, javax.ws.rs.container.ContainerResponseContext responseContext)

Methods inherited from class Object

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

Constructor Details

JaxrsContainerFilter

public JaxrsContainerFilter()

Default constructor construct new instance with JaxrsContainerExtractor, PropagationComponent.getTraceContextFormat() and as public endpoint.

See Also:

• JaxrsContainerFilter(HttpExtractor, TextFormat, Boolean)

JaxrsContainerFilter

public JaxrsContainerFilter(HttpExtractor<io.opencensus.contrib.http.jaxrs.ExtendedContainerRequest, javax.ws.rs.container.ContainerResponseContext> extractor,
 TextFormat propagationFormat,
 Boolean publicEndpoint)

Construct instance with custom configuration.

Parameters:

extractor - the HttpExtractor used to extract information from the request/response.

propagationFormat - the TextFormat used in HTTP propagation.

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.

Method Details

filter

public void filter(javax.ws.rs.container.ContainerRequestContext requestContext)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerRequestFilter

Throws:

IOException

filter

public void filter(javax.ws.rs.container.ContainerRequestContext requestContext,
 javax.ws.rs.container.ContainerResponseContext responseContext)
            throws IOException

Specified by:

filter in interface javax.ws.rs.container.ContainerResponseFilter

Throws:

IOException