public final class Metric extends java.lang.Object implements MetricNumericConverter, scala.Product, scala.Serializable
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.
Constructor and Description |
---|
Metric(java.lang.String name,
java.lang.Number value,
scala.Option<EWMA> average) |
Modifier and Type | Method and Description |
---|---|
scala.Option<EWMA> |
average() |
static scala.Option<Metric> |
create(java.lang.String name,
java.lang.Number value,
scala.Option<java.lang.Object> decayFactor)
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)
Creates a new Metric instance if the Try is successful and the value is valid,
otherwise None is returned.
|
static scala.Option<EWMA> |
createEWMA(double value,
scala.Option<java.lang.Object> decayFactor) |
boolean |
equals(java.lang.Object obj) |
int |
hashCode() |
boolean |
isSmooth() |
java.lang.String |
name() |
boolean |
sameAs(Metric that)
Returns true if
that is tracking the same metric as this. |
double |
smoothValue()
The numerical value of the average, if defined, otherwise the latest value
|
java.lang.Number |
value() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
convertNumber, defined
public Metric(java.lang.String name, java.lang.Number value, scala.Option<EWMA> average)
public static scala.Option<Metric> create(java.lang.String name, java.lang.Number value, scala.Option<java.lang.Object> decayFactor)
name
- (undocumented)value
- (undocumented)decayFactor
- (undocumented)public static scala.Option<Metric> create(java.lang.String name, scala.util.Try<java.lang.Number> value, scala.Option<java.lang.Object> decayFactor)
name
- (undocumented)value
- (undocumented)decayFactor
- (undocumented)public static scala.Option<EWMA> createEWMA(double value, scala.Option<java.lang.Object> decayFactor)
public java.lang.String name()
public java.lang.Number value()
public scala.Option<EWMA> average()
public double smoothValue()
public boolean isSmooth()
public boolean sameAs(Metric that)
that
is tracking the same metric as this.that
- (undocumented)public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in interface scala.Equals
equals
in class java.lang.Object