Package org.infinispan.commons.stat

Class GaugeMetricInfo<T>

java.lang.Object

org.infinispan.commons.stat.GaugeMetricInfo<T>

All Implemented Interfaces:

MetricInfo

public final class GaugeMetricInfo<T>
extends Object

Represents a gauge metric.

A gauge tracks a specific value, like a queue size.

Since:

15.0

Constructor Summary

Constructors

Constructor	Description
GaugeMetricInfo(String name, String description, Map<String,String> map, Function<T,Number> function)

Method Summary

Modifier and Type	Method	Description
final String	getDescription()
Supplier<Number>	getGauge(T instance)
final String	getName()
final Map<String,String>	getTags()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

GaugeMetricInfo

public GaugeMetricInfo(String name,
 String description,
 Map<String,String> map,
 Function<T,Number> function)

Method Details

getGauge

public Supplier<Number> getGauge(T instance)

Returns:

The Supplier to be invoked to fetch the value from instance.

getName

public final String getName()

Specified by:

getName in interface MetricInfo

Returns:

The metrics name.

getDescription

public final String getDescription()

Specified by:

getDescription in interface MetricInfo

Returns:

The metrics description/help message.

getTags

public final Map<String,String> getTags()

Specified by:

getTags in interface MetricInfo

Returns:

The tags to be used. Must be non-null.

toString

public String toString()

Overrides:

toString in class Object