net.devh.boot.grpc.server.metric

Class MetricCollectingServerInterceptor

java.lang.Object

net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

net.devh.boot.grpc.server.metric.MetricCollectingServerInterceptor

All Implemented Interfaces:

io.grpc.ServerInterceptor

@GrpcGlobalServerInterceptor
public class MetricCollectingServerInterceptor
extends net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor
implements io.grpc.ServerInterceptor

A gRPC server interceptor that will collect metrics for micrometer.

Nested Class Summary

Nested classes/interfaces inherited from class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor.MetricSet

Field Summary

Fields inherited from class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

counterCustomizer, eagerInitializedCodes, registry, timerCustomizer

Constructor Summary

Constructors

Constructor and Description
MetricCollectingServerInterceptor(io.micrometer.core.instrument.MeterRegistry registry) Creates a new gRPC server interceptor that will collect metrics into the given MeterRegistry.
MetricCollectingServerInterceptor(io.micrometer.core.instrument.MeterRegistry registry, java.util.function.UnaryOperator<io.micrometer.core.instrument.Counter.Builder> counterCustomizer, java.util.function.UnaryOperator<io.micrometer.core.instrument.Timer.Builder> timerCustomizer, io.grpc.Status.Code... eagerInitializedCodes) Creates a new gRPC server interceptor that will collect metrics into the given MeterRegistry and uses the given customizer to configure the Counters and Timers.

Method Summary

Modifier and Type	Method and Description
<Q,A> io.grpc.ServerCall.Listener<Q>	interceptCall(io.grpc.ServerCall<Q,A> call, io.grpc.Metadata requestHeaders, io.grpc.ServerCallHandler<Q,A> next)
protected io.micrometer.core.instrument.Counter	newRequestCounterFor(io.grpc.MethodDescriptor<?,?> method)
protected io.micrometer.core.instrument.Counter	newResponseCounterFor(io.grpc.MethodDescriptor<?,?> method)
protected java.util.function.Function<io.grpc.Status.Code,io.micrometer.core.instrument.Timer>	newTimerFunction(io.grpc.MethodDescriptor<?,?> method)
void	preregisterService(io.grpc.BindableService service) Pre-registers the all methods provided by the given service.
void	preregisterService(io.grpc.ServerServiceDefinition serviceDefinition) Pre-registers the all methods provided by the given service.

Methods inherited from class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

asTimerFunction, metricsFor, newMetricsFor, preregisterMethod, preregisterService

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricCollectingServerInterceptor

public MetricCollectingServerInterceptor(io.micrometer.core.instrument.MeterRegistry registry)

Creates a new gRPC server interceptor that will collect metrics into the given MeterRegistry.

Parameters:

registry - The registry to use.

MetricCollectingServerInterceptor

public MetricCollectingServerInterceptor(io.micrometer.core.instrument.MeterRegistry registry,
                                         java.util.function.UnaryOperator<io.micrometer.core.instrument.Counter.Builder> counterCustomizer,
                                         java.util.function.UnaryOperator<io.micrometer.core.instrument.Timer.Builder> timerCustomizer,
                                         io.grpc.Status.Code... eagerInitializedCodes)

Creates a new gRPC server interceptor that will collect metrics into the given MeterRegistry and uses the given customizer to configure the Counters and Timers.

Parameters:

registry - The registry to use.

counterCustomizer - The unary function that can be used to customize the created counters.

timerCustomizer - The unary function that can be used to customize the created timers.

eagerInitializedCodes - The status codes that should be eager initialized.

Method Detail

preregisterService

public void preregisterService(io.grpc.BindableService service)

Pre-registers the all methods provided by the given service. This will initialize all default counters and timers for those methods.

Parameters:

service - The service to initialize the meters for.

See Also:

preregisterService(ServerServiceDefinition)

preregisterService

public void preregisterService(io.grpc.ServerServiceDefinition serviceDefinition)

Pre-registers the all methods provided by the given service. This will initialize all default counters and timers for those methods.

Parameters:

serviceDefinition - The service to initialize the meters for.

See Also:

AbstractMetricCollectingInterceptor.preregisterService(ServiceDescriptor)

newRequestCounterFor

protected io.micrometer.core.instrument.Counter newRequestCounterFor(io.grpc.MethodDescriptor<?,?> method)

Specified by:

newRequestCounterFor in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

newResponseCounterFor

protected io.micrometer.core.instrument.Counter newResponseCounterFor(io.grpc.MethodDescriptor<?,?> method)

Specified by:

newResponseCounterFor in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

newTimerFunction

protected java.util.function.Function<io.grpc.Status.Code,io.micrometer.core.instrument.Timer> newTimerFunction(io.grpc.MethodDescriptor<?,?> method)

Specified by:

newTimerFunction in class net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor

interceptCall

public <Q,A> io.grpc.ServerCall.Listener<Q> interceptCall(io.grpc.ServerCall<Q,A> call,
                                                          io.grpc.Metadata requestHeaders,
                                                          io.grpc.ServerCallHandler<Q,A> next)

Specified by:

interceptCall in interface io.grpc.ServerInterceptor