Package io.helidon.webserver.opentracing

Class OpentracingClientFilter

java.lang.Object

io.helidon.webserver.opentracing.OpentracingClientFilter

All Implemented Interfaces:

ClientRequestFilter, ClientResponseFilter

public class OpentracingClientFilter
extends java.lang.Object
implements ClientRequestFilter, ClientResponseFilter

This filter adds tracing information the the associated JAX-RS client call based on the provided properties.

In order to inject the tracing information properly, Tracer and an optional parent SpanContext needs to be resolved. The Tracer gets resolved in following order

1. Directly from property TRACER_PROPERTY_NAME
2. From ServerConfiguration.tracer() referenced by property SERVER_REQUEST_PROPERTY_NAME where an instance of ServerRequest is expected
3. Finally, a global tracer is tried by calling GlobalTracer.get()

The SpanContext as a parent span is resolved as follows

1. Directly from property CURRENT_SPAN_CONTEXT_PROPERTY_NAME
2. From ServerRequest.spanContext() ()} referenced by property SERVER_REQUEST_PROPERTY_NAME where an instance of ServerRequest is expected

For each client call, a new Span with operation name jersey-client-call is created based on the resolved Tracer and an optional parent Span.

If Tracer doesn't get resolved, a warning is logged.

See Also:

Opentraceable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENT_SPAN_CONTEXT_PROPERTY_NAME The SpanContext reference property name.
static java.lang.String	SERVER_REQUEST_PROPERTY_NAME The ServerRequest reference property name.
static java.lang.String	TRACER_PROPERTY_NAME The Tracer property reference name.

Constructor Summary

Constructors

Constructor and Description
OpentracingClientFilter()

Method Summary

Modifier and Type	Method and Description
void	filter(ClientRequestContext requestContext)
void	filter(ClientRequestContext requestContext, ClientResponseContext responseContext)

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_REQUEST_PROPERTY_NAME

public static final java.lang.String SERVER_REQUEST_PROPERTY_NAME

The ServerRequest reference property name.

TRACER_PROPERTY_NAME

public static final java.lang.String TRACER_PROPERTY_NAME

The Tracer property reference name.

See Also:

Constant Field Values

CURRENT_SPAN_CONTEXT_PROPERTY_NAME

public static final java.lang.String CURRENT_SPAN_CONTEXT_PROPERTY_NAME

The SpanContext reference property name.

See Also:

Constant Field Values

Constructor Detail

OpentracingClientFilter

public OpentracingClientFilter()

Method Detail

filter

public void filter(ClientRequestContext requestContext)
            throws java.io.IOException

Specified by:

filter in interface ClientRequestFilter

Throws:

java.io.IOException

filter

public void filter(ClientRequestContext requestContext,
                   ClientResponseContext responseContext)
            throws java.io.IOException

Specified by:

filter in interface ClientResponseFilter

Throws:

java.io.IOException