Package io.servicetalk.opentracing.http

Class TracingHttpRequesterFilter

java.lang.Object

io.servicetalk.opentracing.http.TracingHttpRequesterFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

public class TracingHttpRequesterFilter
extends java.lang.Object
implements StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory, HttpExecutionStrategyInfluencer

An HTTP filter that supports open tracing.

Append this filter before others that are expected to to see Scope for this request/response. Filters appended after this filter that use operators with the after* prefix on response meta data or the StreamingHttpResponse.transformMessageBody(UnaryOperator) response message body} (e.g. Publisher.afterFinally(Runnable)) will execute after this filter invokes Scope.close() and therefore will not see the Span for the current request/response.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	componentName
protected InMemoryTraceStateFormat<HttpHeaders>	formatter
protected io.opentracing.Tracer	tracer

Constructor Summary

Constructors

Constructor	Description
TracingHttpRequesterFilter(io.opentracing.Tracer tracer, java.lang.String componentName)	Create a new instance.
TracingHttpRequesterFilter(io.opentracing.Tracer tracer, java.lang.String componentName, boolean validateTraceKeyFormat)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
StreamingHttpClientFilter	create(FilterableStreamingHttpClient client)	Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.
StreamingHttpConnectionFilter	create(FilterableStreamingHttpConnection connection)	Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.
HttpExecutionStrategy	influenceStrategy(HttpExecutionStrategy strategy)	Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.http.api.StreamingHttpClientFilterFactory

append, asMultiAddressClientFilter

Methods inherited from interface io.servicetalk.http.api.StreamingHttpConnectionFilterFactory

append

Field Detail

tracer

protected final io.opentracing.Tracer tracer

componentName

protected final java.lang.String componentName

formatter

protected final InMemoryTraceStateFormat<HttpHeaders> formatter

Constructor Detail

TracingHttpRequesterFilter

public TracingHttpRequesterFilter(io.opentracing.Tracer tracer,
                                  java.lang.String componentName)

Create a new instance.

Parameters:

tracer - The Tracer.

componentName - The component name used during building new spans.

TracingHttpRequesterFilter

public TracingHttpRequesterFilter(io.opentracing.Tracer tracer,
                                  java.lang.String componentName,
                                  boolean validateTraceKeyFormat)

Create a new instance.

Parameters:

tracer - The Tracer.

componentName - The component name used during building new spans.

validateTraceKeyFormat - true to validate the contents of the trace ids.

Method Detail

create

public final StreamingHttpClientFilter create(FilterableStreamingHttpClient client)

Description copied from interface: StreamingHttpClientFilterFactory

Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.

Specified by:

create in interface StreamingHttpClientFilterFactory

Parameters:

client - FilterableStreamingHttpClient to filter

Returns:

StreamingHttpClientFilter using the provided StreamingHttpClientFilter.

create

public final StreamingHttpConnectionFilter create(FilterableStreamingHttpConnection connection)

Description copied from interface: StreamingHttpConnectionFilterFactory

Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.

Specified by:

create in interface StreamingHttpConnectionFilterFactory

Parameters:

connection - FilterableStreamingHttpConnection to filter

Returns:

StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.

influenceStrategy

public HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy strategy)

Description copied from interface: HttpExecutionStrategyInfluencer

Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.

Specified by:

influenceStrategy in interface HttpExecutionStrategyInfluencer

Parameters:

strategy - HttpExecutionStrategy to influence.

Returns:

HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer