Class/Object

akka.cluster.metrics

Metric

Related Docs: object Metric | package metrics

Permalink

final case class Metric extends MetricNumericConverter with Product with Serializable

Metrics key/value.

Equality of Metric is based on its name.

Annotations
@SerialVersionUID()
Source
Metric.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, MetricNumericConverter, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Metric
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. MetricNumericConverter
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Metric to any2stringadd[Metric] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Metric, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Metric to ArrowAssoc[Metric] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def :+(latest: Metric): Metric

    Permalink

    Updates the data point, and if defined, updates the data stream (average).

    Updates the data point, and if defined, updates the data stream (average). Returns the updated metric.

  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val average: Option[EWMA]

    Permalink

    the data stream of the metric value, for trending over time.

    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.

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def convertNumber(from: Any): Either[Long, Double]

    Permalink

    May involve rounding or truncation.

    May involve rounding or truncation.

    Definition Classes
    MetricNumericConverter
  11. def defined(value: Number): Boolean

    Permalink

    An defined value is neither negative nor NaN/Infinite:

    An defined value is neither negative nor NaN/Infinite:

    • JMX system load average and max heap can be 'undefined' for certain OS, in which case a -1 is returned
    • SIGAR combined CPU can occasionally return a NaN or Infinite (known bug)
    Definition Classes
    MetricNumericConverter
  12. def ensuring(cond: (Metric) ⇒ Boolean, msg: ⇒ Any): Metric

    Permalink
    Implicit information
    This member is added by an implicit conversion from Metric to Ensuring[Metric] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Metric) ⇒ Boolean): Metric

    Permalink
    Implicit information
    This member is added by an implicit conversion from Metric to Ensuring[Metric] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): Metric

    Permalink
    Implicit information
    This member is added by an implicit conversion from Metric to Ensuring[Metric] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Metric

    Permalink
    Implicit information
    This member is added by an implicit conversion from Metric to Ensuring[Metric] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(obj: Any): Boolean

    Permalink
    Definition Classes
    Metric → Equals → AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Metric to StringFormat[Metric] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink
    Definition Classes
    Metric → AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def isSmooth: Boolean

    Permalink

    returns

    true if this value is smoothed

  24. val name: String

    Permalink

    the metric name

  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def sameAs(that: Metric): Boolean

    Permalink

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

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

  29. def smoothValue: Double

    Permalink

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

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. val value: Number

    Permalink

    the metric value, which must be a valid numerical value, a valid value is neither negative nor NaN/Infinite.

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def [B](y: B): (Metric, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Metric to ArrowAssoc[Metric] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from MetricNumericConverter

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Metric to any2stringadd[Metric]

Inherited by implicit conversion StringFormat from Metric to StringFormat[Metric]

Inherited by implicit conversion Ensuring from Metric to Ensuring[Metric]

Inherited by implicit conversion ArrowAssoc from Metric to ArrowAssoc[Metric]

Ungrouped