Package io.servicetalk.opentelemetry.http

Class OpenTelemetryHttpServerFilter

java.lang.Object

io.servicetalk.opentelemetry.http.OpenTelemetryHttpServerFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class OpenTelemetryHttpServerFilter
extends Object
implements StreamingHttpServiceFilterFactory

A StreamingHttpService 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 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
OpenTelemetryHttpServerFilter()	Create a new Instance, searching for any instance of an opentelemetry available.
OpenTelemetryHttpServerFilter(io.opentelemetry.api.OpenTelemetry openTelemetry)	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.
OpenTelemetryHttpServerFilter(OpenTelemetryOptions opentelemetryOptions)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
StreamingHttpServiceFilter	create(StreamingHttpService service)	Create a StreamingHttpServiceFilter using the provided StreamingHttpService.
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

OpenTelemetryHttpServerFilter

@Deprecated
public OpenTelemetryHttpServerFilter(io.opentelemetry.api.OpenTelemetry openTelemetry)

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 OpenTelemetryHttpServerFilter(OpenTelemetryOptions) or OpenTelemetryHttpServerFilter() instead.

Create a new instance.

Parameters:

openTelemetry - the OpenTelemetry.

OpenTelemetryHttpServerFilter

public OpenTelemetryHttpServerFilter()

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

OpenTelemetryHttpServerFilter

public OpenTelemetryHttpServerFilter(OpenTelemetryOptions opentelemetryOptions)

Create a new instance.

Parameters:

opentelemetryOptions - extra options to create the opentelemetry filter

Method Details

create

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