Package io.servicetalk.opentelemetry.http

Class OpenTelemetryHttpServiceFilter

java.lang.Object

io.servicetalk.opentelemetry.http.OpenTelemetryHttpServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class OpenTelemetryHttpServiceFilter
extends Object

A StreamingHttpService that supports open telemetry.

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

This filter propagates the OpenTelemetry Context (thus Span) so the ordering of filters is crucial.

• Append this filter before others that are expected to see the Span for this request/response.
• If you want to see the correct Span information for auto-drained requests (when a streaming request body was not consumed by the service), add the HttpRequestAutoDrainingServiceFilter immediately after.
• To ensure tracing sees the same result status codes as the calling client, add the HttpExceptionMapperServiceFilter after this filter.
• If you intend to use a HttpLifecycleObserver, add it using the HttpLifecycleObserverServiceFilter after the tracing filter to ensure the correct Span information is present.

Be sure to use the HttpServerBuilder.appendNonOffloadingServiceFilter(StreamingHttpServiceFilterFactory) method for adding these filters as non-offloading filters are always added before offloading filters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenTelemetryHttpServiceFilter.Builder	Builder for constructing OpenTelemetryHttpServiceFilter filter instances.

Constructor Summary

Constructors

Constructor	Description
OpenTelemetryHttpServiceFilter()	Deprecated. use the OpenTelemetryHttpServiceFilter.Builder to construct filter instances.
OpenTelemetryHttpServiceFilter(OpenTelemetryOptions openTelemetryOptions)	Deprecated. use the OpenTelemetryHttpServiceFilter.Builder to construct filter instances.

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

OpenTelemetryHttpServiceFilter

@Deprecated
public OpenTelemetryHttpServiceFilter()

Deprecated.

use the OpenTelemetryHttpServiceFilter.Builder to construct filter instances.

Create a new instance using the OpenTelemetry from GlobalOpenTelemetry.get() with default OpenTelemetryOptions.

OpenTelemetryHttpServiceFilter

@Deprecated
public OpenTelemetryHttpServiceFilter(OpenTelemetryOptions openTelemetryOptions)

Deprecated.

use the OpenTelemetryHttpServiceFilter.Builder to construct filter instances.

Create a new instance.

Parameters:

openTelemetryOptions - extra options to create the opentelemetry filter. Client-specific options (componentName, openTelemetry, ignoreSpanSuppression) will be ignored for server filters.

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.