akka.cluster

Class Metric

java.lang.Object

akka.cluster.Metric

All Implemented Interfaces:

MetricNumericConverter, java.io.Serializable, scala.Equals, scala.Product

Deprecated.

Superseded by akka.cluster.metrics (in akka-cluster-metrics jar). Since 2.4.

public final class Metric
extends java.lang.Object
implements MetricNumericConverter, scala.Product, scala.Serializable

Metrics key/value.

Equality of Metric is based on its name.

param: name the metric name param: value the metric value, which must be a valid numerical value, a valid value is neither negative nor NaN/Infinite. param: average the data stream of the metric value, for trending over time. Metrics that are already averages (e.g. system load average) or finite (e.g. as number of processors), are not trended.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Metric(java.lang.String name, java.lang.Number value, scala.Option<EWMA> average) Deprecated.

Method Summary

Modifier and Type	Method and Description
scala.Option<EWMA>	average() Deprecated.
abstract static boolean	canEqual(java.lang.Object that) Deprecated.
static scala.util.Either<java.lang.Object,java.lang.Object>	convertNumber(java.lang.Object from) Deprecated.
static scala.Option<Metric>	create(java.lang.String name, java.lang.Number value, scala.Option<java.lang.Object> decayFactor) Deprecated. Creates a new Metric instance if the value is valid, otherwise None is returned.
static scala.Option<Metric>	create(java.lang.String name, scala.util.Try<java.lang.Number> value, scala.Option<java.lang.Object> decayFactor) Deprecated. Creates a new Metric instance if the Try is successful and the value is valid, otherwise None is returned.
static boolean	defined(java.lang.Number value) Deprecated.
boolean	equals(java.lang.Object obj) Deprecated.
int	hashCode() Deprecated.
boolean	isSmooth() Deprecated.
java.lang.String	name() Deprecated.
abstract static int	productArity() Deprecated.
abstract static java.lang.Object	productElement(int n) Deprecated.
static scala.collection.Iterator<java.lang.Object>	productIterator() Deprecated.
static java.lang.String	productPrefix() Deprecated.
boolean	sameAs(Metric that) Deprecated. Returns true if that is tracking the same metric as this.
double	smoothValue() Deprecated. The numerical value of the average, if defined, otherwise the latest value
java.lang.Number	value() Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.cluster.MetricNumericConverter

convertNumber, defined

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual

Constructor Detail

Metric

public Metric(java.lang.String name,
              java.lang.Number value,
              scala.Option<EWMA> average)

Deprecated.

Method Detail

create

public static scala.Option<Metric> create(java.lang.String name,
                                          java.lang.Number value,
                                          scala.Option<java.lang.Object> decayFactor)

Deprecated.

Creates a new Metric instance if the value is valid, otherwise None is returned. Invalid numeric values are negative and NaN/Infinite.

Parameters:

name - (undocumented)

value - (undocumented)

decayFactor - (undocumented)

Returns:

(undocumented)

create

public static scala.Option<Metric> create(java.lang.String name,
                                          scala.util.Try<java.lang.Number> value,
                                          scala.Option<java.lang.Object> decayFactor)

Deprecated.

Creates a new Metric instance if the Try is successful and the value is valid, otherwise None is returned. Invalid numeric values are negative and NaN/Infinite.

Parameters:

name - (undocumented)

value - (undocumented)

decayFactor - (undocumented)

Returns:

(undocumented)

defined

public static boolean defined(java.lang.Number value)

Deprecated.

convertNumber

public static scala.util.Either<java.lang.Object,java.lang.Object> convertNumber(java.lang.Object from)

Deprecated.

canEqual

public abstract static boolean canEqual(java.lang.Object that)

Deprecated.

productElement

public abstract static java.lang.Object productElement(int n)

Deprecated.

productArity

public abstract static int productArity()

Deprecated.

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

Deprecated.

productPrefix

public static java.lang.String productPrefix()

Deprecated.

name

public java.lang.String name()

Deprecated.

value

public java.lang.Number value()

Deprecated.

average

public scala.Option<EWMA> average()

Deprecated.

smoothValue

public double smoothValue()

Deprecated.

The numerical value of the average, if defined, otherwise the latest value

Returns:

(undocumented)

isSmooth

public boolean isSmooth()

Deprecated.

Returns:

true if this value is smoothed

sameAs

public boolean sameAs(Metric that)

Deprecated.

Returns true if that is tracking the same metric as this.

Parameters:

that - (undocumented)

Returns:

(undocumented)

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Deprecated.

Specified by:

equals in interface scala.Equals

Overrides:

equals in class java.lang.Object