com.gigaspaces.metrics

Class Gauge<T>

java.lang.Object

com.gigaspaces.metrics.Metric

com.gigaspaces.metrics.Gauge<T>

Type Parameters:

T - the type of the metric's value

Direct Known Subclasses:

InternalGauge

public abstract class Gauge<T>
extends Metric

A gauge metric is an instantaneous reading of a particular value. To instrument a queue's depth, for example:

 final Queue<String> queue = new ConcurrentLinkedQueue<String>();
 final Gauge<Integer> queueDepth = new Gauge<Integer>() {
     public Integer getValue() {
         return queue.size();
     }
 };
 

Since:

10.1

Author:

Niv Ingberg

Constructor Summary

Constructors

Constructor and Description
Gauge()

Method Summary

Modifier and Type	Method and Description
protected double	calculatePercent(long value, long total)
abstract T	getValue() Returns the metric's current value.
protected static Double	validate(double value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Gauge

public Gauge()

Method Detail

getValue

public abstract T getValue()
                    throws Exception

Returns the metric's current value.

Returns:

the metric's current value

Throws:

Exception

calculatePercent

protected double calculatePercent(long value,
                                  long total)

validate

protected static Double validate(double value)