akka.cluster.metrics

Class ClusterMetricsExtension

java.lang.Object

akka.cluster.metrics.ClusterMetricsExtension

All Implemented Interfaces:

Extension

public class ClusterMetricsExtension
extends java.lang.Object
implements Extension

Cluster metrics extension.

Cluster metrics is primarily for load-balancing of nodes. It controls metrics sampling at a regular frequency, prepares highly variable data for further analysis by other entities, and publishes the latest cluster metrics data around the node ring and local eventStream to assist in determining the need to redirect traffic to the least-loaded nodes.

Metrics sampling is delegated to the MetricsCollector.

Smoothing of the data for each monitored process is delegated to the EWMA for exponential weighted moving average.

Constructor Summary

Constructors

Constructor and Description
ClusterMetricsExtension(ExtendedActorSystem system)

Method Summary

Modifier and Type	Method and Description
static ClusterMetricsExtension	createExtension(ExtendedActorSystem system)
static ClusterMetricsExtension	get(ActorSystem system)
static ClusterMetricsExtension$	lookup()
ClusterMetricsSettings	settings() Metrics extension configuration.
SupervisorStrategy	strategy() INTERNAL API
void	subscribe(ActorRef metricsListener) Subscribe user metrics listener actor unto ClusterMetricsEvent events published by extension on the system event bus.
ActorRef	supervisor() Supervisor actor.
void	unsubscribe(ActorRef metricsListenter) Unsubscribe user metrics listener actor from ClusterMetricsEvent events published by extension on the system event bus.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterMetricsExtension

public ClusterMetricsExtension(ExtendedActorSystem system)

Method Detail

lookup

public static ClusterMetricsExtension$ lookup()

get

public static ClusterMetricsExtension get(ActorSystem system)

createExtension

public static ClusterMetricsExtension createExtension(ExtendedActorSystem system)

settings

public ClusterMetricsSettings settings()

Metrics extension configuration.

Returns:

(undocumented)

strategy

public SupervisorStrategy strategy()

INTERNAL API

Supervision strategy.

Returns:

(undocumented)

supervisor

public ActorRef supervisor()

Supervisor actor. Accepts subtypes of CollectionControlMessages to manage metrics collection at runtime.

Returns:

(undocumented)

subscribe

public void subscribe(ActorRef metricsListener)

Subscribe user metrics listener actor unto ClusterMetricsEvent events published by extension on the system event bus.

Parameters:

metricsListener - (undocumented)

unsubscribe

public void unsubscribe(ActorRef metricsListenter)

Unsubscribe user metrics listener actor from ClusterMetricsEvent events published by extension on the system event bus.

Parameters:

metricsListenter - (undocumented)