Package net.devh.boot.grpc.server.metrics

Class MetricsServerStreamTracers

java.lang.Object

net.devh.boot.grpc.server.metrics.MetricsServerStreamTracers

public final class MetricsServerStreamTracers
extends Object

Provides factories for StreamTracer that records metrics.

On the server-side, there is only one ServerStream per each ServerCall, and ServerStream starts earlier than the ServerCall. Therefore, only one tracer is created per stream/call and it's the tracer that reports the metrics summary. Note: This class uses experimental grpc-java-API features.

Constructor Summary

Constructors

Constructor	Description
MetricsServerStreamTracers()
MetricsServerStreamTracers(Supplier<Stopwatch> stopwatchSupplier)

Method Summary

Modifier and Type	Method	Description
ServerStreamTracer.Factory	getMetricsServerTracerFactory(MeterRegistry registry)	Returns a ServerStreamTracer.Factory with default metrics definitions.
ServerStreamTracer.Factory	getMetricsServerTracerFactory(MetricsServerMeters meters)	Returns a ServerStreamTracer.Factory with metrics definitions from custom MetricsServerMeters.

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsServerStreamTracers

public MetricsServerStreamTracers()

MetricsServerStreamTracers

public MetricsServerStreamTracers(Supplier<Stopwatch> stopwatchSupplier)

Method Details

getMetricsServerTracerFactory

public ServerStreamTracer.Factory getMetricsServerTracerFactory(MeterRegistry registry)

Returns a ServerStreamTracer.Factory with default metrics definitions.

Parameters:

registry - The MeterRegistry used to create the metrics.

getMetricsServerTracerFactory

public ServerStreamTracer.Factory getMetricsServerTracerFactory(MetricsServerMeters meters)

Returns a ServerStreamTracer.Factory with metrics definitions from custom MetricsServerMeters.

Parameters:

meters - The MetricsServerMeters used to configure the metrics definitions.