Package io.servicetalk.opentracing.http

Class TracingHttpRequesterFilter

java.lang.Object

io.servicetalk.opentracing.http.TracingHttpRequesterFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public class TracingHttpRequesterFilter
extends Object
implements StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

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.

Constructor Summary

Constructors

Constructor	Description
TracingHttpRequesterFilter(io.opentracing.Tracer tracer, io.opentracing.propagation.Format<io.opentracing.propagation.TextMap> format, String componentName)	Create a new instance.
TracingHttpRequesterFilter(io.opentracing.Tracer tracer, String componentName)	Create a new instance.
TracingHttpRequesterFilter(io.opentracing.Tracer tracer, String componentName, boolean validateTraceKeyFormat)	Create a new instance.
TracingHttpRequesterFilter(io.opentracing.Tracer tracer, String componentName, io.opentracing.propagation.Format<HttpHeaders> format)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
final StreamingHttpClientFilter	create(FilterableStreamingHttpClient client)	Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.
final StreamingHttpConnectionFilter	create(FilterableStreamingHttpConnection connection)	Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.
HttpExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.

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.HttpExecutionStrategyInfluencer

influenceStrategy

Constructor Details

TracingHttpRequesterFilter

public TracingHttpRequesterFilter(io.opentracing.Tracer tracer,
 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,
 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.

TracingHttpRequesterFilter

public TracingHttpRequesterFilter(io.opentracing.Tracer tracer,
 String componentName,
 io.opentracing.propagation.Format<HttpHeaders> format)

Create a new instance.

Parameters:

tracer - The Tracer.

componentName - The component name used during building new spans.

format - the Format to use to inject/extract trace info to/from HttpHeaders.

TracingHttpRequesterFilter

public TracingHttpRequesterFilter(io.opentracing.Tracer tracer,
 io.opentracing.propagation.Format<io.opentracing.propagation.TextMap> format,
 String componentName)

Create a new instance.

Parameters:

tracer - The Tracer.

format - the Format to use to inject/extract trace info to/from TextMap.

componentName - The component name used during building new spans.

Method Details

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.

requiredOffloads

public HttpExecutionStrategy requiredOffloads()

Description copied from interface: HttpExecutionStrategyInfluencer

Return an ExecutionStrategy that describes the offloads required by the influencer.

The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Returns:

the ExecutionStrategy required by the influencer.