net.devh.boot.grpc.client.metric

Class MetricCollectingClientInterceptor

java.lang.Object

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

net.devh.boot.grpc.client.metric.MetricCollectingClientInterceptor

All Implemented Interfaces:

io.grpc.ClientInterceptor

@GrpcGlobalClientInterceptor
public class MetricCollectingClientInterceptor
extends net.devh.boot.grpc.common.metric.AbstractMetricCollectingInterceptor
implements io.grpc.ClientInterceptor

A gRPC client 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
MetricCollectingClientInterceptor(io.micrometer.core.instrument.MeterRegistry registry) Creates a new gRPC client interceptor that will collect metrics into the given MeterRegistry.
MetricCollectingClientInterceptor(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 client 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.ClientCall<Q,A>	interceptCall(io.grpc.MethodDescriptor<Q,A> methodDescriptor, io.grpc.CallOptions callOptions, io.grpc.Channel channel)
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)

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

MetricCollectingClientInterceptor

@Autowired
public MetricCollectingClientInterceptor(io.micrometer.core.instrument.MeterRegistry registry)

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

Parameters:

registry - The registry to use.

MetricCollectingClientInterceptor

public MetricCollectingClientInterceptor(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 client 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

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.ClientCall<Q,A> interceptCall(io.grpc.MethodDescriptor<Q,A> methodDescriptor,
                                                   io.grpc.CallOptions callOptions,
                                                   io.grpc.Channel channel)

Specified by:

interceptCall in interface io.grpc.ClientInterceptor