Module io.helidon.tracing.jersey

Package io.helidon.tracing.jersey

Class AbstractTracingFilter

java.lang.Object

io.helidon.tracing.jersey.AbstractTracingFilter

All Implemented Interfaces:

ContainerRequestFilter, ContainerResponseFilter

Direct Known Subclasses:

MpTracingFilter, TracingFilter

@ConstrainedTo(SERVER)
@PreMatching
public abstract class AbstractTracingFilter
extends Object
implements ContainerRequestFilter, ContainerResponseFilter

Tracing filter base.

Constructor Summary

Constructors

Constructor	Description
AbstractTracingFilter()

Method Summary

Modifier and Type	Method	Description
protected abstract void	configureSpan(Tracer.SpanBuilder spanBuilder)	Configure additional properties of a span that is named and has a parent.
void	filter(ContainerRequestContext requestContext)
void	filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext)
protected abstract String	spanName(ContainerRequestContext context)	Create name of the newly created span.
protected abstract boolean	tracingEnabled(ContainerRequestContext context)	Whether this tracing filter is enabled.
protected String	url(ContainerRequestContext requestContext)	Resolves host name based on the "host" header.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTracingFilter

public AbstractTracingFilter()

Method Detail

filter

public void filter(ContainerRequestContext requestContext)

Specified by:

filter in interface ContainerRequestFilter

url

protected String url(ContainerRequestContext requestContext)

Resolves host name based on the "host" header. If this header is not set, then URI.toString() is called.

Parameters:

requestContext - request context

Returns:

resolved url

filter

public void filter(ContainerRequestContext requestContext,
                   ContainerResponseContext responseContext)

Specified by:

filter in interface ContainerResponseFilter

tracingEnabled

protected abstract boolean tracingEnabled(ContainerRequestContext context)

Whether this tracing filter is enabled.

Parameters:

context - request context

Returns:

true if filter should trigger and start a new span

spanName

protected abstract String spanName(ContainerRequestContext context)

Create name of the newly created span.

Parameters:

context - request context

Returns:

name of the span to be created

configureSpan

protected abstract void configureSpan(Tracer.SpanBuilder spanBuilder)

Configure additional properties of a span that is named and has a parent.

Parameters:

spanBuilder - builder of the new span