Package io.servicetalk.opentelemetry.http

Class OpenTelemetryHttpRequestFilter

java.lang.Object

io.servicetalk.opentelemetry.http.OpenTelemetryHttpRequestFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class OpenTelemetryHttpRequestFilter
extends Object
implements StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

An HTTP filter that supports open telemetry.

The filter gets a Tracer with "io.servicetalk" instrumentation scope name.

Append this filter before others that are expected 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
OpenTelemetryHttpRequestFilter()	Create a new instance, searching for any instance of an opentelemetry available, using the hostname as the component name.
OpenTelemetryHttpRequestFilter(io.opentelemetry.api.OpenTelemetry openTelemetry, String componentName)	Deprecated. this method is internal, no user should be setting the OpenTelemetry as it is obtained by using GlobalOpenTelemetry.get() and there should be no other implementations but the one available in the classpath, this constructor will be removed in the future releases.
OpenTelemetryHttpRequestFilter(String componentName)	Create a new instance, searching for any instance of an opentelemetry available.
OpenTelemetryHttpRequestFilter(String componentName, OpenTelemetryOptions opentelemetryOptions)	Create a new instance, searching for any instance of an opentelemetry available.

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.
final 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, requiredOffloads

Constructor Details

OpenTelemetryHttpRequestFilter

@Deprecated
public OpenTelemetryHttpRequestFilter(io.opentelemetry.api.OpenTelemetry openTelemetry,
 String componentName)

Deprecated.

this method is internal, no user should be setting the OpenTelemetry as it is obtained by using GlobalOpenTelemetry.get() and there should be no other implementations but the one available in the classpath, this constructor will be removed in the future releases. Use OpenTelemetryHttpRequestFilter(String, OpenTelemetryOptions) or OpenTelemetryHttpRequestFilter() instead.

Create a new instance.

Parameters:

openTelemetry - the OpenTelemetry.

componentName - The component name used during building new spans.

OpenTelemetryHttpRequestFilter

public OpenTelemetryHttpRequestFilter(String componentName)

Create a new instance, searching for any instance of an opentelemetry available.

Parameters:

componentName - The component name used during building new spans.

OpenTelemetryHttpRequestFilter

public OpenTelemetryHttpRequestFilter(String componentName,
 OpenTelemetryOptions opentelemetryOptions)

Create a new instance, searching for any instance of an opentelemetry available.

Parameters:

componentName - The component name used during building new spans.

opentelemetryOptions - extra options to create the opentelemetry filter

OpenTelemetryHttpRequestFilter

public OpenTelemetryHttpRequestFilter()

Create a new instance, searching for any instance of an opentelemetry available, using the hostname as the component name.

Method Details

create

public 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 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 final 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.