akka.cluster.metrics

Class ClusterMetricsCollector

java.lang.Object

akka.cluster.metrics.ClusterMetricsCollector

All Implemented Interfaces:

Actor, ActorLogging

public class ClusterMetricsCollector
extends java.lang.Object
implements Actor, ActorLogging

INTERNAL API.

Actor responsible for periodic data sampling in the node and publication to the cluster.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

Actor.emptyBehavior$, Actor.ignoringBehavior$

Constructor Summary

Constructors

Constructor and Description
ClusterMetricsCollector()

Method Summary

Modifier and Type	Method and Description
void	addMember(Member member) Adds a member to the node ring.
Cluster	cluster()
MetricsCollector	collector() The metrics collector that samples data on the node.
ActorContext	context() Stores the context for this actor, including self, and sender.
void	gossip() Gossip to peer nodes.
Cancellable	gossipTask() Start periodic gossip to random nodes in cluster
void	gossipTo(Address address)
MetricsGossip	latestGossip() The latest metric values with their statistical data.
ClusterMetricsExtension	metrics()
scala.collection.immutable.SortedSet<Address>	nodes() The node ring gossipped that contains only members that are Up.
void	postStop() User overridable callback.
void	preStart() User overridable callback.
void	publish() Publishes to the event stream.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	receive() This defines the initial actor behavior, it must return a partial function with the actor logic.
void	receiveGossip(MetricsGossipEnvelope envelope) Receives changes from peer nodes, merges remote with local gossip nodes, then publishes changes to the event stream for load balancing router consumption, and gossip back.
void	receiveState(ClusterEvent.CurrentClusterState state) Updates the initial node ring for those nodes that are MemberStatus Up.
void	removeMember(Member member) Removes a member from the member node ring.
void	replyGossipTo(Address address)
void	sample() Samples the latest metrics for the node, updates metrics statistics in MetricsGossip, and publishes the change to the event bus.
Cancellable	sampleTask() Start periodic metrics collection
scala.Option<Address>	selectRandomNode(scala.collection.immutable.IndexedSeq<Address> addresses)
ActorRef	self() The 'self' field holds the ActorRef for this actor.
void	sendGossip(Address address, MetricsGossipEnvelope envelope)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akka.actor.Actor

aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, postRestart, preRestart, sender, supervisorStrategy, unhandled

Methods inherited from interface akka.actor.ActorLogging

log

Constructor Detail

ClusterMetricsCollector

public ClusterMetricsCollector()

Method Detail

context

public ActorContext context()

Description copied from interface: Actor

Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

ActorContext is the Scala API. getContext returns a UntypedActorContext, which is the Java API of the actor context.

Specified by:

context in interface Actor

Returns:

(undocumented)

self

public final ActorRef self()

Description copied from interface: Actor

The 'self' field holds the ActorRef for this actor.

Can be used to send messages to itself:

 self ! message
 

Specified by:

self in interface Actor

Returns:

(undocumented)

cluster

public Cluster cluster()

metrics

public ClusterMetricsExtension metrics()

nodes

public scala.collection.immutable.SortedSet<Address> nodes()

The node ring gossipped that contains only members that are Up.

Returns:

(undocumented)

latestGossip

public MetricsGossip latestGossip()

The latest metric values with their statistical data.

Returns:

(undocumented)

collector

public MetricsCollector collector()

The metrics collector that samples data on the node.

Returns:

(undocumented)

gossipTask

public Cancellable gossipTask()

Start periodic gossip to random nodes in cluster

Returns:

(undocumented)

sampleTask

public Cancellable sampleTask()

Start periodic metrics collection

Returns:

(undocumented)

preStart

public void preStart()

Description copied from interface: Actor

User overridable callback.

Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

Specified by:

preStart in interface Actor

receive

public scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> receive()

Description copied from interface: Actor

This defines the initial actor behavior, it must return a partial function with the actor logic.

Specified by:

receive in interface Actor

Returns:

(undocumented)

postStop

public void postStop()

Description copied from interface: Actor

User overridable callback.

Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

Specified by:

postStop in interface Actor

addMember

public void addMember(Member member)

Adds a member to the node ring.

Parameters:

member - (undocumented)

removeMember

public void removeMember(Member member)

Removes a member from the member node ring.

Parameters:

member - (undocumented)

receiveState

public void receiveState(ClusterEvent.CurrentClusterState state)

Updates the initial node ring for those nodes that are MemberStatus Up.

Parameters:

state - (undocumented)

sample

public void sample()

Samples the latest metrics for the node, updates metrics statistics in MetricsGossip, and publishes the change to the event bus.

See Also:

MetricsCollector

receiveGossip

public void receiveGossip(MetricsGossipEnvelope envelope)

Receives changes from peer nodes, merges remote with local gossip nodes, then publishes changes to the event stream for load balancing router consumption, and gossip back.

Parameters:

envelope - (undocumented)

gossip

public void gossip()

Gossip to peer nodes.

gossipTo

public void gossipTo(Address address)

replyGossipTo

public void replyGossipTo(Address address)

sendGossip

public void sendGossip(Address address,
                       MetricsGossipEnvelope envelope)

selectRandomNode

public scala.Option<Address> selectRandomNode(scala.collection.immutable.IndexedSeq<Address> addresses)

publish

public void publish()

Publishes to the event stream.