Package org.apache.pulsar.broker.loadbalance.extensions

Class ExtensibleLoadManagerWrapper

java.lang.Object

org.apache.pulsar.broker.loadbalance.extensions.ExtensibleLoadManagerWrapper

All Implemented Interfaces:

LoadManager

public class ExtensibleLoadManagerWrapper
extends Object
implements LoadManager

Field Summary

Fields inherited from interface org.apache.pulsar.broker.loadbalance.LoadManager

LOADBALANCE_BROKERS_ROOT, LOG

Constructor Summary

Constructors

Constructor	Description
ExtensibleLoadManagerWrapper(ExtensibleLoadManagerImpl loadManager)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Boolean>	checkOwnershipAsync(Optional<org.apache.pulsar.common.naming.ServiceUnitId> topic, org.apache.pulsar.common.naming.ServiceUnitId bundle)
void	disableBroker()	Removes visibility of current broker from loadbalancer list so, other brokers can't redirect any request to this broker and this broker won't accept new connection requests.
void	doLoadShedding()	Unload a candidate service unit to balance the load.
void	doNamespaceBundleSplit()	Namespace bundle split.
CompletableFuture<Optional<LookupResult>>	findBrokerServiceUrl(Optional<org.apache.pulsar.common.naming.ServiceUnitId> topic, org.apache.pulsar.common.naming.ServiceUnitId bundle, LookupOptions options)
org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport	generateLoadReport()	Generate the load report.
ExtensibleLoadManagerImpl	get()
Set<String>	getAvailableBrokers()	Get list of available brokers in cluster.
CompletableFuture<Set<String>>	getAvailableBrokersAsync()
Optional<ResourceUnit>	getLeastLoaded(org.apache.pulsar.common.naming.ServiceUnitId su)	Returns the Least Loaded Resource Unit decided by some algorithm or criteria which is implementation specific.
List<org.apache.pulsar.common.stats.Metrics>	getLoadBalancingMetrics()	Generate load balancing stats metrics.
void	initialize(PulsarService pulsar)	Initialize this LoadManager.
boolean	isCentralized()	Is centralized decision making to assign a new bundle.
void	setLoadReportForceUpdateFlag()	Set flag to force load report update.
String	setNamespaceBundleAffinity(String bundle, String broker)
void	start()
boolean	started()
void	stop()
void	writeLoadReportOnZookeeper()	Publish the current load report on ZK.
void	writeResourceQuotasToZooKeeper()	Update namespace bundle resource quota on ZK.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.broker.loadbalance.LoadManager

writeLoadReportOnZookeeper

Constructor Details

ExtensibleLoadManagerWrapper

public ExtensibleLoadManagerWrapper(ExtensibleLoadManagerImpl loadManager)

Method Details

start

public void start()
           throws PulsarServerException

Specified by:

start in interface LoadManager

Throws:

PulsarServerException

started

public boolean started()

Specified by:

started in interface LoadManager

initialize

public void initialize(PulsarService pulsar)

Description copied from interface: LoadManager

Initialize this LoadManager.

Specified by:

initialize in interface LoadManager

Parameters:

pulsar - The service to initialize this with.

isCentralized

public boolean isCentralized()

Description copied from interface: LoadManager

Is centralized decision making to assign a new bundle.

Specified by:

isCentralized in interface LoadManager

findBrokerServiceUrl

public CompletableFuture<Optional<LookupResult>> findBrokerServiceUrl(Optional<org.apache.pulsar.common.naming.ServiceUnitId> topic,
 org.apache.pulsar.common.naming.ServiceUnitId bundle,
 LookupOptions options)

Specified by:

findBrokerServiceUrl in interface LoadManager

checkOwnershipAsync

public CompletableFuture<Boolean> checkOwnershipAsync(Optional<org.apache.pulsar.common.naming.ServiceUnitId> topic,
 org.apache.pulsar.common.naming.ServiceUnitId bundle)

Specified by:

checkOwnershipAsync in interface LoadManager

disableBroker

public void disableBroker()
                   throws Exception

Description copied from interface: LoadManager

Removes visibility of current broker from loadbalancer list so, other brokers can't redirect any request to this broker and this broker won't accept new connection requests.

Specified by:

disableBroker in interface LoadManager

Throws:

Exception - if there is any error while disabling broker

getAvailableBrokers

public Set<String> getAvailableBrokers()
                                throws Exception

Description copied from interface: LoadManager

Get list of available brokers in cluster.

Specified by:

getAvailableBrokers in interface LoadManager

Returns:

the list of available brokers

Throws:

Exception - if there is any error while getting available brokers

getAvailableBrokersAsync

public CompletableFuture<Set<String>> getAvailableBrokersAsync()

Specified by:

getAvailableBrokersAsync in interface LoadManager

setNamespaceBundleAffinity

public String setNamespaceBundleAffinity(String bundle,
 String broker)

Specified by:

setNamespaceBundleAffinity in interface LoadManager

stop

public void stop()
          throws PulsarServerException

Specified by:

stop in interface LoadManager

Throws:

PulsarServerException

getLeastLoaded

public Optional<ResourceUnit> getLeastLoaded(org.apache.pulsar.common.naming.ServiceUnitId su)
                                      throws Exception

Description copied from interface: LoadManager

Returns the Least Loaded Resource Unit decided by some algorithm or criteria which is implementation specific.

Specified by:

getLeastLoaded in interface LoadManager

Throws:

Exception

generateLoadReport

public org.apache.pulsar.policies.data.loadbalancer.LoadManagerReport generateLoadReport()

Description copied from interface: LoadManager

Generate the load report.

Specified by:

generateLoadReport in interface LoadManager

setLoadReportForceUpdateFlag

public void setLoadReportForceUpdateFlag()

Description copied from interface: LoadManager

Set flag to force load report update.

Specified by:

setLoadReportForceUpdateFlag in interface LoadManager

writeLoadReportOnZookeeper

public void writeLoadReportOnZookeeper()
                                throws Exception

Description copied from interface: LoadManager

Publish the current load report on ZK.

Specified by:

writeLoadReportOnZookeeper in interface LoadManager

Throws:

Exception

writeResourceQuotasToZooKeeper

public void writeResourceQuotasToZooKeeper()
                                    throws Exception

Description copied from interface: LoadManager

Update namespace bundle resource quota on ZK.

Specified by:

writeResourceQuotasToZooKeeper in interface LoadManager

Throws:

Exception

getLoadBalancingMetrics

public List<org.apache.pulsar.common.stats.Metrics> getLoadBalancingMetrics()

Description copied from interface: LoadManager

Generate load balancing stats metrics.

Specified by:

getLoadBalancingMetrics in interface LoadManager

doLoadShedding

public void doLoadShedding()

Description copied from interface: LoadManager

Unload a candidate service unit to balance the load.

Specified by:

doLoadShedding in interface LoadManager

doNamespaceBundleSplit

public void doNamespaceBundleSplit()

Description copied from interface: LoadManager

Namespace bundle split.

Specified by:

doNamespaceBundleSplit in interface LoadManager

get

public ExtensibleLoadManagerImpl get()