c

akka.cluster.metrics

JmxMetricsCollector

class JmxMetricsCollector extends MetricsCollector

Loads JVM and system metrics through JMX monitoring beans.

Source
MetricsCollector.scala
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JmxMetricsCollector
  2. MetricsCollector
  3. Closeable
  4. AutoCloseable
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new JmxMetricsCollector(system: ActorSystem)

    This constructor is used when creating an instance from configured FQCN

  2. new JmxMetricsCollector(address: Address, decayFactor: Double)

    address

    The akka.actor.Address of the node being sampled

    decayFactor

    how quickly the exponential weighting of past data is decayed

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from JmxMetricsCollector toany2stringadd[JmxMetricsCollector] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JmxMetricsCollector, B)
    Implicit
    This member is added by an implicit conversion from JmxMetricsCollector toArrowAssoc[JmxMetricsCollector] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def close(): Unit
    Definition Classes
    JmxMetricsCollector → Closeable → AutoCloseable
  9. def ensuring(cond: (JmxMetricsCollector) => Boolean, msg: => Any): JmxMetricsCollector
    Implicit
    This member is added by an implicit conversion from JmxMetricsCollector toEnsuring[JmxMetricsCollector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (JmxMetricsCollector) => Boolean): JmxMetricsCollector
    Implicit
    This member is added by an implicit conversion from JmxMetricsCollector toEnsuring[JmxMetricsCollector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): JmxMetricsCollector
    Implicit
    This member is added by an implicit conversion from JmxMetricsCollector toEnsuring[JmxMetricsCollector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): JmxMetricsCollector
    Implicit
    This member is added by an implicit conversion from JmxMetricsCollector toEnsuring[JmxMetricsCollector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def heapCommitted(heap: MemoryUsage): Option[Metric]

    (JMX) Returns the current sum of heap memory guaranteed to be available to the JVM from all heap memory pools (in bytes).

    (JMX) Returns the current sum of heap memory guaranteed to be available to the JVM from all heap memory pools (in bytes). Creates a new instance each time.

  18. def heapMax(heap: MemoryUsage): Option[Metric]

    (JMX) Returns the maximum amount of memory (in bytes) that can be used for JVM memory management.

    (JMX) Returns the maximum amount of memory (in bytes) that can be used for JVM memory management. If not defined the metrics value is None, i.e. never negative. Creates a new instance each time.

  19. def heapMemoryUsage: MemoryUsage

    Current heap to be passed in to heapUsed, heapCommitted and heapMax

  20. def heapUsed(heap: MemoryUsage): Option[Metric]

    (JMX) Returns the current sum of heap memory used from all heap memory pools (in bytes).

    (JMX) Returns the current sum of heap memory used from all heap memory pools (in bytes). Creates a new instance each time.

  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def metrics(): Set[Metric]

    Generate metrics set.

    Generate metrics set. Creates a new instance each time.

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def processors: Option[Metric]

    (JMX) Returns the number of available processors Creates a new instance each time.

  27. def sample(): NodeMetrics

    Samples and collects new data points.

    Samples and collects new data points. Creates a new instance each time.

    Definition Classes
    JmxMetricsCollectorMetricsCollector
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def systemLoadAverage: Option[Metric]

    (JMX) Returns the OS-specific average load on the CPUs in the system, for the past 1 minute.

    (JMX) Returns the OS-specific average load on the CPUs in the system, for the past 1 minute. On some systems the JMX OS system load average may not be available, in which case a -1 is returned from JMX, and None is returned from this method. Creates a new instance each time.

  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JmxMetricsCollector toStringFormat[JmxMetricsCollector] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (JmxMetricsCollector, B)
    Implicit
    This member is added by an implicit conversion from JmxMetricsCollector toArrowAssoc[JmxMetricsCollector] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from MetricsCollector

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromJmxMetricsCollector to any2stringadd[JmxMetricsCollector]

Inherited by implicit conversion StringFormat fromJmxMetricsCollector to StringFormat[JmxMetricsCollector]

Inherited by implicit conversion Ensuring fromJmxMetricsCollector to Ensuring[JmxMetricsCollector]

Inherited by implicit conversion ArrowAssoc fromJmxMetricsCollector to ArrowAssoc[JmxMetricsCollector]

Ungrouped