c

akka.cluster.metrics

SigarMetricsCollector

class SigarMetricsCollector extends JmxMetricsCollector

Loads metrics through Hyperic SIGAR and JMX monitoring beans. This loads wider and more accurate range of metrics compared to JmxMetricsCollector by using SIGAR's native OS library.

The constructor will by design throw exception if org.hyperic.sigar.Sigar can't be loaded, due to missing classes or native libraries.

Source
MetricsCollector.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SigarMetricsCollector
  2. JmxMetricsCollector
  3. MetricsCollector
  4. Closeable
  5. AutoCloseable
  6. AnyRef
  7. 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 SigarMetricsCollector(system: ActorSystem)

    This constructor is used when creating an instance from configured FQCN

  2. new SigarMetricsCollector(address: Address, settings: ClusterMetricsSettings)
  3. new SigarMetricsCollector(address: Address, settings: ClusterMetricsSettings, sigar: SigarProxy)
  4. new SigarMetricsCollector(address: Address, decayFactor: Double, sigar: SigarProxy)

    address

    The akka.actor.Address of the node being sampled

    decayFactor

    how quickly the exponential weighting of past data is decayed

    sigar

    the org.hyperic.Sigar instance

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 SigarMetricsCollector toany2stringadd[SigarMetricsCollector] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SigarMetricsCollector, B)
    Implicit
    This member is added by an implicit conversion from SigarMetricsCollector toArrowAssoc[SigarMetricsCollector] 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

    Releases any native resources associated with this instance.

    Releases any native resources associated with this instance.

    Definition Classes
    SigarMetricsCollectorJmxMetricsCollector → Closeable → AutoCloseable
  9. def cpuCombined(cpuPerc: CpuPerc): Option[Metric]

    (SIGAR) Returns the combined CPU sum of User + Sys + Nice + Wait, in percentage.

    (SIGAR) Returns the combined CPU sum of User + Sys + Nice + Wait, in percentage. This metric can describe the amount of time the CPU spent executing code during n-interval and how much more it could theoretically. Note that 99% CPU utilization can be optimal or indicative of failure.

    In the data stream, this will sometimes return with a valid metric value, and sometimes as a NaN or Infinite. Documented bug 749121 and several others.

    Creates a new instance each time.

  10. def cpuIdle(cpuPerc: CpuPerc): Option[Metric]

    (SIGAR) Returns the idle CPU time.

    (SIGAR) Returns the idle CPU time. Amount of CPU time left after combined and stolen are removed.

    Creates a new instance each time.

  11. def cpuStolen(cpuPerc: CpuPerc): Option[Metric]

    (SIGAR) Returns the stolen CPU time.

    (SIGAR) Returns the stolen CPU time. Relevant to virtual hosting environments. For details please see: Wikipedia - CPU time subdivision and Understanding AWS stolen CPU and how it affects your apps

    Creates a new instance each time.

  12. def ensuring(cond: (SigarMetricsCollector) => Boolean, msg: => Any): SigarMetricsCollector
    Implicit
    This member is added by an implicit conversion from SigarMetricsCollector toEnsuring[SigarMetricsCollector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (SigarMetricsCollector) => Boolean): SigarMetricsCollector
    Implicit
    This member is added by an implicit conversion from SigarMetricsCollector toEnsuring[SigarMetricsCollector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): SigarMetricsCollector
    Implicit
    This member is added by an implicit conversion from SigarMetricsCollector toEnsuring[SigarMetricsCollector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): SigarMetricsCollector
    Implicit
    This member is added by an implicit conversion from SigarMetricsCollector toEnsuring[SigarMetricsCollector] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SigarMetricsCollector toStringFormat[SigarMetricsCollector] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. 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.

    Definition Classes
    JmxMetricsCollector
  22. 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.

    Definition Classes
    JmxMetricsCollector
  23. def heapMemoryUsage: MemoryUsage

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

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

    Definition Classes
    JmxMetricsCollector
  24. 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.

    Definition Classes
    JmxMetricsCollector
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def metrics(): Set[Metric]

    Generate metrics set.

    Generate metrics set. Creates a new instance each time.

    Definition Classes
    SigarMetricsCollectorJmxMetricsCollector
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def processors: Option[Metric]

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

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

    Definition Classes
    JmxMetricsCollector
  31. def sample(): NodeMetrics

    Samples and collects new data points.

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

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

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

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

    Creates a new instance each time.

    Definition Classes
    SigarMetricsCollectorJmxMetricsCollector
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. 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 [B](y: B): (SigarMetricsCollector, B)
    Implicit
    This member is added by an implicit conversion from SigarMetricsCollector toArrowAssoc[SigarMetricsCollector] 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 JmxMetricsCollector

Inherited from MetricsCollector

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSigarMetricsCollector to any2stringadd[SigarMetricsCollector]

Inherited by implicit conversion StringFormat fromSigarMetricsCollector to StringFormat[SigarMetricsCollector]

Inherited by implicit conversion Ensuring fromSigarMetricsCollector to Ensuring[SigarMetricsCollector]

Inherited by implicit conversion ArrowAssoc fromSigarMetricsCollector to ArrowAssoc[SigarMetricsCollector]

Ungrouped