org.springframework.boot.actuate.metrics.rich

Class RichGauge

java.lang.Object

org.springframework.boot.actuate.metrics.rich.RichGauge

public final class RichGauge
extends Object

A gauge which stores the maximum, minimum and average in addition to the current value.

The value of the average will depend on whether a weight ('alpha') is set for the gauge. If it is unset, the average will contain a simple arithmetic mean. If a weight is set, an exponential moving average will be calculated as defined in this NIST document.

Author:

Luke Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALPHA
static String	AVG
static String	COUNT
static String	MAX
static String	MIN
static String	VAL

Constructor Summary

Constructors

Constructor and Description
RichGauge(String name) Creates an "empty" gauge.
RichGauge(String name, double value)
RichGauge(String name, double value, double alpha, double mean, double max, double min, long count)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
double	getAlpha()
double	getAverage() Either an exponential weighted moving average or a simple mean, respectively, depending on whether the weight 'alpha' has been set for this gauge.
long	getCount()
double	getMax()
double	getMin()
String	getName()
double	getValue()
int	hashCode()
RichGauge	setAlpha(double alpha)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

COUNT

public static final String COUNT

See Also:

Constant Field Values

MAX

public static final String MAX

See Also:

Constant Field Values

MIN

public static final String MIN

See Also:

Constant Field Values

AVG

public static final String AVG

See Also:

Constant Field Values

ALPHA

public static final String ALPHA

See Also:

Constant Field Values

VAL

public static final String VAL

See Also:

Constant Field Values

Constructor Detail

RichGauge

public RichGauge(String name)

Creates an "empty" gauge. The average, max and min will be zero, but this initial value will not be included after the first value has been set on the gauge.

Parameters:

name - the name under which the gauge will be stored.

RichGauge

public RichGauge(String name,
                 double value)

RichGauge

public RichGauge(String name,
                 double value,
                 double alpha,
                 double mean,
                 double max,
                 double min,
                 long count)

Method Detail

getName

public String getName()

Returns:

the name of the gauge

getValue

public double getValue()

Returns:

the current value

getAverage

public double getAverage()

Either an exponential weighted moving average or a simple mean, respectively, depending on whether the weight 'alpha' has been set for this gauge.

Returns:

The average over all the accumulated values

getMax

public double getMax()

Returns:

the maximum value

getMin

public double getMin()

Returns:

the minimum value

getCount

public long getCount()

Returns:

Number of times the value has been set.

getAlpha

public double getAlpha()

Returns:

the smoothing constant value.

setAlpha

public RichGauge setAlpha(double alpha)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object