package cluster
- Alphabetic
- Public
- All
Type Members
-
final
class
AutoDowning
extends DowningProvider
Used when no custom provider is configured and 'auto-down-unreachable-after' is enabled.
-
class
Cluster
extends Extension
This module is responsible cluster membership information.
This module is responsible cluster membership information. Changes to the cluster information is retrieved through #subscribe. Commands to operate the cluster is available through methods in this class, such as #join, #down and #leave.
Each cluster Member is identified by its akka.actor.Address, and the cluster address of this actor system is #selfAddress. A member also has a status; initially MemberStatus
Joining
followed by MemberStatusUp
. -
trait
ClusterMessage
extends Serializable
Base trait for all cluster messages.
Base trait for all cluster messages. All ClusterMessage's are serializable.
-
trait
ClusterNodeMBean
extends AnyRef
Interface for the cluster JMX MBean.
-
abstract
class
ClusterScope
extends Scope
- Annotations
- @SerialVersionUID()
- final class ClusterSettings extends AnyRef
-
abstract
class
DowningProvider
extends AnyRef
API for plugins that will handle downing of cluster nodes.
API for plugins that will handle downing of cluster nodes. Concrete plugins must subclass and have a public one argument constructor accepting an akka.actor.ActorSystem.
-
class
Member
extends Serializable
Represents the address, current status, and roles of a cluster member node.
Represents the address, current status, and roles of a cluster member node.
Note:
hashCode
andequals
are solely based on the underlyingAddress
, not itsMemberStatus
and roles.- Annotations
- @SerialVersionUID()
-
sealed abstract
class
MemberStatus
extends AnyRef
Defines the current status of a cluster member node
Defines the current status of a cluster member node
Can be one of: Joining, WeaklyUp, Up, Leaving, Exiting and Down and Removed.
-
final
class
NoDowning
extends DowningProvider
Default downing provider used when no provider is configured and 'auto-down-unreachable-after' is not enabled.
-
final
case class
UniqueAddress
(address: Address, longUid: Long) extends Ordered[UniqueAddress] with Product with Serializable
Member identifier consisting of address and random
uid
.Member identifier consisting of address and random
uid
. Theuid
is needed to be able to distinguish different incarnations of a member with same hostname and port.- Annotations
- @SerialVersionUID()
-
final
case class
VectorClock
(versions: TreeMap[Node, Long] = ...) extends Product with Serializable
Representation of a Vector-based clock (counting clock), inspired by Lamport logical clocks.
Representation of a Vector-based clock (counting clock), inspired by Lamport logical clocks.
Reference: 1) Leslie Lamport (1978). "Time, clocks, and the ordering of events in a distributed system". Communications of the ACM 21 (7): 558-565. 2) Friedemann Mattern (1988). "Virtual Time and Global States of Distributed Systems". Workshop on Parallel and Distributed Algorithms: pp. 215-226
Based on code from the 'vlock' VectorClock library by Coda Hale.
- Annotations
- @SerialVersionUID()
-
class
JmxMetricsCollector
extends MetricsCollector
Loads JVM and system metrics through JMX monitoring beans.
Loads JVM and system metrics through JMX monitoring beans.
- Annotations
- @deprecated
- Deprecated
(Since version 2.4) Superseded by akka.cluster.metrics (in akka-cluster-metrics jar)
-
final
case class
Metric
extends MetricNumericConverter with Product with Serializable
Metrics key/value.
Metrics key/value.
Equality of Metric is based on its name.
- Annotations
- @SerialVersionUID() @deprecated
- Deprecated
(Since version 2.4) Superseded by akka.cluster.metrics (in akka-cluster-metrics jar)
-
trait
MetricsCollector
extends Closeable
Implementations of cluster system metrics extends this trait.
Implementations of cluster system metrics extends this trait.
- Annotations
- @deprecated
- Deprecated
(Since version 2.4) Superseded by akka.cluster.metrics (in akka-cluster-metrics jar)
-
final
case class
NodeMetrics
(address: Address, timestamp: Long, metrics: Set[Metric] = Set.empty[Metric]) extends Product with Serializable
The snapshot of current sampled health metrics for any monitored process.
The snapshot of current sampled health metrics for any monitored process. Collected and gossipped at regular intervals for dynamic cluster management strategies.
Equality of NodeMetrics is based on its address.
- address
akka.actor.Address of the node the metrics are gathered at
- timestamp
the time of sampling, in milliseconds since midnight, January 1, 1970 UTC
- metrics
the set of sampled akka.cluster.Metric
- Annotations
- @SerialVersionUID() @deprecated
- Deprecated
(Since version 2.4) Superseded by akka.cluster.metrics (in akka-cluster-metrics jar)
-
class
SigarMetricsCollector
extends JmxMetricsCollector
Loads metrics through Hyperic SIGAR and JMX monitoring beans.
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.
- Annotations
- @deprecated
- Deprecated
(Since version 2.4) Superseded by akka.cluster.metrics (in akka-cluster-metrics jar)
Value Members
-
object
Cluster
extends ExtensionId[Cluster] with ExtensionIdProvider
Cluster Extension Id and factory for creating Cluster extension.
-
object
ClusterEvent
Domain events published to the event bus.
Domain events published to the event bus. Subscribe with:
Cluster(system).subscribe(actorRef, classOf[ClusterDomainEvent])
-
object
ClusterScope
extends ClusterScope with Product with Serializable
Cluster aware scope of a akka.actor.Deploy
- object GossipEnvelope extends Serializable
-
object
Member
extends Serializable
Module with factory and ordering methods for Member instances.
- object MemberStatus
- object UniqueAddress extends AbstractFunction2[Address, Int, UniqueAddress] with Serializable
Deprecated Value Members
-
object
Metric
extends MetricNumericConverter with Serializable
Factory for creating valid Metric instances.
Factory for creating valid Metric instances.
- Annotations
- @deprecated
- Deprecated
(Since version 2.4) Superseded by akka.cluster.metrics (in akka-cluster-metrics jar)
-
object
StandardMetrics
Definitions of the built-in standard metrics.
Definitions of the built-in standard metrics.
The following extractors and data structures makes it easy to consume the akka.cluster.NodeMetrics in for example load balancers.
- Annotations
- @deprecated
- Deprecated
(Since version 2.4) Superseded by akka.cluster.metrics (in akka-cluster-metrics jar)