Package org.apache.pekko.cluster.metrics

Class ClusterMetricsExtension

java.lang.Object

org.apache.pekko.cluster.metrics.ClusterMetricsExtension

All Implemented Interfaces:

Extension

public class ClusterMetricsExtension
extends 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	Description
ClusterMetricsExtension(ExtendedActorSystem system)

Method Summary

Modifier and Type	Method	Description
static T	apply(ActorSystem system)
static T	apply(ClassicActorSystemProvider system)
static ClusterMetricsExtension	createExtension(ExtendedActorSystem system)
static final boolean	equals(Object other)
static ClusterMetricsExtension	get(ActorSystem system)
static ClusterMetricsExtension	get(ClassicActorSystemProvider system)
static final int	hashCode()
static ClusterMetricsExtension$	lookup()
ClusterMetricsSettings	settings()	Metrics extension configuration.
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 Details

ClusterMetricsExtension

public ClusterMetricsExtension(ExtendedActorSystem system)

Method Details

lookup

public static ClusterMetricsExtension$ lookup()

get

public static ClusterMetricsExtension get(ActorSystem system)

get

public static ClusterMetricsExtension get(ClassicActorSystemProvider system)

createExtension

public static ClusterMetricsExtension createExtension(ExtendedActorSystem system)

apply

public static T apply(ActorSystem system)

apply

public static T apply(ClassicActorSystemProvider system)

hashCode

public static final int hashCode()

equals

public static final boolean equals(Object other)

settings

public ClusterMetricsSettings settings()

Metrics extension configuration.

supervisor

public ActorRef supervisor()

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

subscribe

public void subscribe(ActorRef metricsListener)

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

unsubscribe

public void unsubscribe(ActorRef metricsListenter)

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