c

akka.cluster.metrics

JmxMetricsCollector

class JmxMetricsCollector extends MetricsCollector

Loads JVM and system metrics through JMX monitoring beans.

Source
MetricsCollector.scala
Linear Supertypes
MetricsCollector, Closeable, AutoCloseable, AnyRef, Any
Known Subclasses
SigarMetricsCollector
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. def close(): Unit
    Definition Classes
    JmxMetricsCollector → Closeable → AutoCloseable
  2. 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.

  3. 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.

  4. def heapMemoryUsage: MemoryUsage

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

  5. 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.

  6. def metrics(): Set[Metric]

    Generate metrics set.

    Generate metrics set. Creates a new instance each time.

  7. def processors: Option[Metric]

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

  8. def sample(): NodeMetrics

    Samples and collects new data points.

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

    Definition Classes
    JmxMetricsCollector → MetricsCollector
  9. 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.