Package io.grpc.xds.orca

Class OrcaMetricReportingServerInterceptor

java.lang.Object

io.grpc.xds.orca.OrcaMetricReportingServerInterceptor

All Implemented Interfaces:

ServerInterceptor

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/9127")
public final class OrcaMetricReportingServerInterceptor
extends Object
implements ServerInterceptor

A ServerInterceptor that intercepts a ServerCall by running server-side RPC handling under a Context that records custom per-request metrics provided by server applications and sends to client side along with the response in the format of Open Request Cost Aggregation (ORCA).

Since:

1.23.0

Method Summary

Modifier and Type	Method	Description
static OrcaMetricReportingServerInterceptor	create(MetricRecorder metricRecorder)	Creates a new OrcaMetricReportingServerInterceptor instance with the given MetricRecorder.
static OrcaMetricReportingServerInterceptor	getInstance()
<ReqT,RespT> ServerCall.Listener<ReqT>	interceptCall(ServerCall<ReqT,RespT> call, Metadata headers, ServerCallHandler<ReqT,RespT> next)	Intercept ServerCall dispatch by the next ServerCallHandler.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static OrcaMetricReportingServerInterceptor getInstance()

create

public static OrcaMetricReportingServerInterceptor create(@Nullable
                                                          MetricRecorder metricRecorder)

Creates a new OrcaMetricReportingServerInterceptor instance with the given MetricRecorder. When both CallMetricRecorder and MetricRecorder exist, the metrics are merged such that per-request metrics from CallMetricRecorder takes a higher precedence compared to metrics from MetricRecorder.

interceptCall

public <ReqT,RespT> ServerCall.Listener<ReqT> interceptCall(ServerCall<ReqT,RespT> call,
                                                                  Metadata headers,
                                                                  ServerCallHandler<ReqT,RespT> next)

Description copied from interface: ServerInterceptor

Intercept ServerCall dispatch by the next ServerCallHandler. General semantics of ServerCallHandler.startCall(io.grpc.ServerCall<RequestT, ResponseT>, io.grpc.Metadata) apply and the returned ServerCall.Listener must not be null.

If the implementation throws an exception, call will be closed with an error. Implementations must not throw an exception if they started processing that may use call on another thread.

Specified by:

interceptCall in interface ServerInterceptor

Parameters:

call - object to receive response messages

headers - which can contain extra call metadata from ClientCall.start(io.grpc.ClientCall.Listener<RespT>, io.grpc.Metadata), e.g. authentication credentials.

next - next processor in the interceptor chain

Returns:

listener for processing incoming messages for call, never null.