net.devh.boot.grpc.common.metric

Class AbstractMetricCollectingInterceptor

java.lang.Object

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

public abstract class AbstractMetricCollectingInterceptor
extends java.lang.Object

An abstract gRPC interceptor that will collect metrics for micrometer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractMetricCollectingInterceptor.MetricSet Container for all metrics of a certain call.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.UnaryOperator<io.micrometer.core.instrument.Counter.Builder>	counterCustomizer
protected io.grpc.Status.Code[]	eagerInitializedCodes
protected io.micrometer.core.instrument.MeterRegistry	registry
protected java.util.function.UnaryOperator<io.micrometer.core.instrument.Timer.Builder>	timerCustomizer

Constructor Summary

Constructors

Constructor and Description
AbstractMetricCollectingInterceptor(io.micrometer.core.instrument.MeterRegistry registry) Creates a new gRPC interceptor that will collect metrics into the given MeterRegistry.
AbstractMetricCollectingInterceptor(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 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
protected java.util.function.Function<io.grpc.Status.Code,io.micrometer.core.instrument.Timer>	asTimerFunction(java.util.function.Supplier<io.micrometer.core.instrument.Timer.Builder> timerTemplate) Creates a new timer function using the given template.
protected AbstractMetricCollectingInterceptor.MetricSet	metricsFor(io.grpc.MethodDescriptor<?,?> method) Gets or creates a AbstractMetricCollectingInterceptor.MetricSet for the given gRPC method.
protected AbstractMetricCollectingInterceptor.MetricSet	newMetricsFor(io.grpc.MethodDescriptor<?,?> method) Creates a AbstractMetricCollectingInterceptor.MetricSet for the given gRPC method.
protected abstract io.micrometer.core.instrument.Counter	newRequestCounterFor(io.grpc.MethodDescriptor<?,?> method) Creates a new request counter for the given method.
protected abstract io.micrometer.core.instrument.Counter	newResponseCounterFor(io.grpc.MethodDescriptor<?,?> method) Creates a new response counter for the given method.
protected abstract java.util.function.Function<io.grpc.Status.Code,io.micrometer.core.instrument.Timer>	newTimerFunction(io.grpc.MethodDescriptor<?,?> method) Creates a new timer for a given code for the given method.
void	preregisterMethod(io.grpc.MethodDescriptor<?,?> method) Pre-registers the given method.
void	preregisterService(io.grpc.ServiceDescriptor service) Pre-registers the all methods provided by the given service.

Methods inherited from class java.lang.Object

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

Field Detail

registry

protected final io.micrometer.core.instrument.MeterRegistry registry

counterCustomizer

protected final java.util.function.UnaryOperator<io.micrometer.core.instrument.Counter.Builder> counterCustomizer

timerCustomizer

protected final java.util.function.UnaryOperator<io.micrometer.core.instrument.Timer.Builder> timerCustomizer

eagerInitializedCodes

protected final io.grpc.Status.Code[] eagerInitializedCodes

Constructor Detail

AbstractMetricCollectingInterceptor

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

Creates a new gRPC interceptor that will collect metrics into the given MeterRegistry. This method won't use any customizers and will only initialize the OK status.

Parameters:

registry - The registry to use.

AbstractMetricCollectingInterceptor

public AbstractMetricCollectingInterceptor(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 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.ServiceDescriptor 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:

preregisterMethod(MethodDescriptor)

preregisterMethod

public void preregisterMethod(io.grpc.MethodDescriptor<?,?> method)

Pre-registers the given method. This will initialize all default counters and timers for that method.

Parameters:

method - The method to initialize the meters for.

metricsFor

protected final AbstractMetricCollectingInterceptor.MetricSet metricsFor(io.grpc.MethodDescriptor<?,?> method)

Gets or creates a AbstractMetricCollectingInterceptor.MetricSet for the given gRPC method. This will initialize all default counters and timers for that method.

Parameters:

method - The method to get the metric set for.

Returns:

The metric set for the given method.

See Also:

newMetricsFor(MethodDescriptor)

newMetricsFor

protected AbstractMetricCollectingInterceptor.MetricSet newMetricsFor(io.grpc.MethodDescriptor<?,?> method)

Creates a AbstractMetricCollectingInterceptor.MetricSet for the given gRPC method. This will initialize all default counters and timers for that method.

Parameters:

method - The method to get the metric set for.

Returns:

The newly created metric set for the given method.

newRequestCounterFor

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

Creates a new request counter for the given method.

Parameters:

method - The method to create the counter for.

Returns:

The newly created request counter.

newResponseCounterFor

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

Creates a new response counter for the given method.

Parameters:

method - The method to create the counter for.

Returns:

The newly created response counter.

asTimerFunction

protected java.util.function.Function<io.grpc.Status.Code,io.micrometer.core.instrument.Timer> asTimerFunction(java.util.function.Supplier<io.micrometer.core.instrument.Timer.Builder> timerTemplate)

Creates a new timer function using the given template. This method initializes the default timers.

Parameters:

timerTemplate - The template to create the instances from.

Returns:

The newly created function that returns a timer for a given code.

newTimerFunction

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

Creates a new timer for a given code for the given method.

Parameters:

method - The method to create the timer for.

Returns:

The newly created function that returns a timer for a given code.