io.servicetalk.grpc.netty

Class GrpcLifecycleObserverServiceFilter

Object

HttpLifecycleObserverServiceFilter

GrpcLifecycleObserverServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class GrpcLifecycleObserverServiceFilter
extends HttpLifecycleObserverServiceFilter

An HTTP service filter that tracks events during gRPC request/response lifecycle.

The recommended approach is to use GrpcServerBuilder.lifecycleObserver(GrpcLifecycleObserver) to configure an observer that captures entire state of the request processing. In cases when an observer should be moved down in a filter chain or applied conditionally, this filter can be used.

This filter is recommended to be appended as the first filter at the HttpServerBuilder.appendNonOffloadingServiceFilter(StreamingHttpServiceFilterFactory) or HttpServerBuilder.appendServiceFilter(StreamingHttpServiceFilterFactory) (which can be configured using GrpcServerBuilder.initializeHttp(GrpcServerBuilder.HttpInitializer)) to account for all work done by other filters. If it's preferred to get visibility to information populated by other filters (like tracing keys), it can be appended after those filters.

Constructor Summary

Constructors

Constructor and Description
GrpcLifecycleObserverServiceFilter(GrpcLifecycleObserver observer) Create a new instance.

Method Summary

Modifier and Type	Method and Description
HttpExecutionStrategy	influenceStrategy(HttpExecutionStrategy arg0)
HttpExecutionStrategy	requiredOffloads()

Methods inherited from class HttpLifecycleObserverServiceFilter

create

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer, influenceStrategy, requiredOffloads

Constructor Detail

GrpcLifecycleObserverServiceFilter

public GrpcLifecycleObserverServiceFilter(GrpcLifecycleObserver observer)

Create a new instance.

Parameters:

observer - The observer implementation that consumes gRPC lifecycle events.

Method Detail

requiredOffloads

public final HttpExecutionStrategy requiredOffloads()

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

influenceStrategy

public final HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy arg0)

Specified by:

influenceStrategy in interface HttpExecutionStrategyInfluencer