Package io.servicetalk.opentracing.http

Class TracingHttpServiceFilter

java.lang.Object

io.servicetalk.opentracing.http.TracingHttpServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public class TracingHttpServiceFilter
extends Object
implements StreamingHttpServiceFilterFactory

A StreamingHttpService 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 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
TracingHttpServiceFilter(io.opentracing.Tracer tracer, io.opentracing.propagation.Format<io.opentracing.propagation.TextMap> format, String componentName)	Create a new instance.
TracingHttpServiceFilter(io.opentracing.Tracer tracer, String componentName)	Create a new instance.
TracingHttpServiceFilter(io.opentracing.Tracer tracer, String componentName, boolean validateTraceKeyFormat)	Create a new instance.
TracingHttpServiceFilter(io.opentracing.Tracer tracer, String componentName, io.opentracing.propagation.Format<HttpHeaders> format)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
final StreamingHttpServiceFilter	create(StreamingHttpService service)	Create a StreamingHttpServiceFilter using the provided StreamingHttpService.
protected String	getOperationName(String componentName, HttpRequestMetaData metaData)	Get the operation name to build the span with.
protected boolean	injectSpanContextIntoResponse(io.opentracing.SpanContext parentSpanContext)	Determine if the current span context should be injected into the response.
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

TracingHttpServiceFilter

public TracingHttpServiceFilter(io.opentracing.Tracer tracer,
 String componentName)

Create a new instance.

Parameters:

tracer - The Tracer.

componentName - The component name used during building new spans.

TracingHttpServiceFilter

public TracingHttpServiceFilter(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.

TracingHttpServiceFilter

public TracingHttpServiceFilter(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.

TracingHttpServiceFilter

public TracingHttpServiceFilter(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 StreamingHttpServiceFilter create(StreamingHttpService service)

Description copied from interface: StreamingHttpServiceFilterFactory

Create a StreamingHttpServiceFilter using the provided StreamingHttpService.

Specified by:

create in interface StreamingHttpServiceFilterFactory

Parameters:

service - StreamingHttpService to filter

Returns:

StreamingHttpServiceFilter using the provided StreamingHttpService.

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.

getOperationName

protected String getOperationName(String componentName,
 HttpRequestMetaData metaData)

Get the operation name to build the span with.

Parameters:

componentName - The component name.

metaData - The HttpRequestMetaData.

Returns:

the operation name to build the span with.

injectSpanContextIntoResponse

protected boolean injectSpanContextIntoResponse(@Nullable
 io.opentracing.SpanContext parentSpanContext)

Determine if the current span context should be injected into the response.

Parameters:

parentSpanContext - The parent span extracted from the request.

Returns:

true if the current span context should be injected into the response.