Package io.helidon.tracing.jersey

Class AbstractTracingFilter

java.lang.Object

io.helidon.tracing.jersey.AbstractTracingFilter

All Implemented Interfaces:

ContainerRequestFilter, ContainerResponseFilter

Direct Known Subclasses:

TracingFilter

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

Tracing filter base.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SPAN_PROPERTY Name of the property the created span is stored in on request filter.

Constructor Summary

Constructors

Constructor and Description
AbstractTracingFilter()

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

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

Field Detail

SPAN_PROPERTY

protected static final String SPAN_PROPERTY

Name of the property the created span is stored in on request filter.

Constructor Detail

AbstractTracingFilter

public AbstractTracingFilter()

Method Detail

filter

public void filter(ContainerRequestContext requestContext)

Specified by:

filter in interface ContainerRequestFilter

filter

public void filter(ContainerRequestContext requestContext,
                   ContainerResponseContext responseContext)
            throws IOException

Specified by:

filter in interface ContainerResponseFilter

Throws:

IOException

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