Package org.apache.pulsar.policies.data.loadbalancer

Class LocalBrokerData

java.lang.Object

org.apache.pulsar.policies.data.loadbalancer.LocalBrokerData

All Implemented Interfaces:

LoadManagerReport, ServiceLookupData

public class LocalBrokerData
extends Object
implements LoadManagerReport

Contains all the data that is maintained locally on each broker.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	loadReportType

Constructor Summary

Constructors

Constructor	Description
LocalBrokerData()
LocalBrokerData(String webServiceUrl, String webServiceUrlTls, String pulsarServiceUrl, String pulsarServiceUrlTls)	Broker data constructor which takes in four URLs to satisfy the contract of ServiceLookupData.
LocalBrokerData(String webServiceUrl, String webServiceUrlTls, String pulsarServiceUrl, String pulsarServiceUrlTls, Map<String,AdvertisedListener> advertisedListeners)

Method Summary

Modifier and Type	Method	Description
void	cleanDeltas()
boolean	equals(Object o)	Since the broker data is also used as a lock for the broker, we need to have a stable comparison operator that is not affected by the actual load on the broker.
Map<String,AdvertisedListener>	getAdvertisedListeners()
ResourceUsage	getBandwidthIn()
ResourceUsage	getBandwidthOut()
String	getBrokerVersionString()
Set<String>	getBundles()
Map<String,NamespaceBundleStats>	getBundleStats()
ResourceUsage	getCpu()
ResourceUsage	getDirectMemory()
Set<String>	getLastBundleGains()
Set<String>	getLastBundleLosses()
Map<String,NamespaceBundleStats>	getLastStats()
long	getLastUpdate()
String	getLoadManagerClassName()
String	getLoadReportType()
double	getMaxResourceUsage()
double	getMaxResourceUsageWithWeight(double cpuWeight, double directMemoryWeight, double bandwidthInWeight, double bandwidthOutWeight)
double	getMaxResourceUsageWithWeight(double cpuWeight, double memoryWeight, double directMemoryWeight, double bandwidthInWeight, double bandwidthOutWeight)	Deprecated.
ResourceUsage	getMemory()
double	getMsgRateIn()
double	getMsgRateOut()
double	getMsgThroughputIn()
double	getMsgThroughputOut()
int	getNumBundles()
int	getNumConsumers()
int	getNumProducers()
int	getNumTopics()
Optional<String>	getProtocol(String protocol)
Map<String,String>	getProtocols()
String	getPulsarServiceUrl()
String	getPulsarServiceUrlTls()
long	getStartTimestamp()
String	getWebServiceUrl()
String	getWebServiceUrlTls()
int	hashCode()
boolean	isNonPersistentTopicsEnabled()
boolean	isPersistentTopicsEnabled()
static double	max(double... args)
String	printResourceUsage()
void	setAdvertisedListeners(Map<String,AdvertisedListener> advertisedListeners)
void	setBandwidthIn(ResourceUsage bandwidthIn)
void	setBandwidthOut(ResourceUsage bandwidthOut)
void	setBrokerVersionString(String brokerVersionString)
void	setBundles(Set<String> bundles)
void	setCpu(ResourceUsage cpu)
void	setDirectMemory(ResourceUsage directMemory)
void	setLastBundleGains(Set<String> lastBundleGains)
void	setLastBundleLosses(Set<String> lastBundleLosses)
void	setLastStats(Map<String,NamespaceBundleStats> lastStats)
void	setLastUpdate(long lastUpdate)
void	setLoadManagerClassName(String loadManagerClassName)
void	setMemory(ResourceUsage memory)
void	setMsgRateIn(double msgRateIn)
void	setMsgRateOut(double msgRateOut)
void	setMsgThroughputIn(double msgThroughputIn)
void	setMsgThroughputOut(double msgThroughputOut)
void	setNonPersistentTopicsEnabled(boolean nonPersistentTopicsEnabled)
void	setNumBundles(int numBundles)
void	setNumConsumers(int numConsumers)
void	setNumProducers(int numProducers)
void	setNumTopics(int numTopics)
void	setPersistentTopicsEnabled(boolean persistentTopicsEnabled)
void	setProtocols(Map<String,String> protocols)
void	update(LocalBrokerData other)	Using another LocalBrokerData, update this.
void	update(SystemResourceUsage systemResourceUsage, Map<String,NamespaceBundleStats> bundleStats)	Using the system resource usage and bundle stats acquired from the Pulsar client, update this LocalBrokerData.

Methods inherited from class java.lang.Object

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

Field Details

loadReportType

public static final String loadReportType

Constructor Details

LocalBrokerData

public LocalBrokerData()

LocalBrokerData

public LocalBrokerData(String webServiceUrl,
 String webServiceUrlTls,
 String pulsarServiceUrl,
 String pulsarServiceUrlTls)

Broker data constructor which takes in four URLs to satisfy the contract of ServiceLookupData.

LocalBrokerData

public LocalBrokerData(String webServiceUrl,
 String webServiceUrlTls,
 String pulsarServiceUrl,
 String pulsarServiceUrlTls,
 Map<String,AdvertisedListener> advertisedListeners)

Method Details

equals

public boolean equals(Object o)

Since the broker data is also used as a lock for the broker, we need to have a stable comparison operator that is not affected by the actual load on the broker.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

update

public void update(SystemResourceUsage systemResourceUsage,
 Map<String,NamespaceBundleStats> bundleStats)

Using the system resource usage and bundle stats acquired from the Pulsar client, update this LocalBrokerData.

Parameters:

systemResourceUsage - System resource usage (cpu, memory, and direct memory).

bundleStats - The bundle stats retrieved from the Pulsar client.

update

public void update(LocalBrokerData other)

Using another LocalBrokerData, update this.

Parameters:

other - LocalBrokerData to update from.

getMaxResourceUsage

public double getMaxResourceUsage()

printResourceUsage

public String printResourceUsage()

getMaxResourceUsageWithWeight

@Deprecated
public double getMaxResourceUsageWithWeight(double cpuWeight,
 double memoryWeight,
 double directMemoryWeight,
 double bandwidthInWeight,
 double bandwidthOutWeight)

Deprecated.

getMaxResourceUsageWithWeight

public double getMaxResourceUsageWithWeight(double cpuWeight,
 double directMemoryWeight,
 double bandwidthInWeight,
 double bandwidthOutWeight)

max

public static double max(double... args)

getLoadReportType

public String getLoadReportType()

getCpu

public ResourceUsage getCpu()

Specified by:

getCpu in interface LoadManagerReport

setCpu

public void setCpu(ResourceUsage cpu)

getMemory

public ResourceUsage getMemory()

Specified by:

getMemory in interface LoadManagerReport

setMemory

public void setMemory(ResourceUsage memory)

getDirectMemory

public ResourceUsage getDirectMemory()

Specified by:

getDirectMemory in interface LoadManagerReport

setDirectMemory

public void setDirectMemory(ResourceUsage directMemory)

getBandwidthIn

public ResourceUsage getBandwidthIn()

Specified by:

getBandwidthIn in interface LoadManagerReport

setBandwidthIn

public void setBandwidthIn(ResourceUsage bandwidthIn)

getBandwidthOut

public ResourceUsage getBandwidthOut()

Specified by:

getBandwidthOut in interface LoadManagerReport

setBandwidthOut

public void setBandwidthOut(ResourceUsage bandwidthOut)

getLastBundleGains

public Set<String> getLastBundleGains()

cleanDeltas

public void cleanDeltas()

setLastBundleGains

public void setLastBundleGains(Set<String> lastBundleGains)

getLastBundleLosses

public Set<String> getLastBundleLosses()

setLastBundleLosses

public void setLastBundleLosses(Set<String> lastBundleLosses)

getLastUpdate

public long getLastUpdate()

Specified by:

getLastUpdate in interface LoadManagerReport

setLastUpdate

public void setLastUpdate(long lastUpdate)

getBundles

public Set<String> getBundles()

setBundles

public void setBundles(Set<String> bundles)

getLastStats

public Map<String,NamespaceBundleStats> getLastStats()

setLastStats

public void setLastStats(Map<String,NamespaceBundleStats> lastStats)

getNumTopics

public int getNumTopics()

Specified by:

getNumTopics in interface LoadManagerReport

setNumTopics

public void setNumTopics(int numTopics)

getNumBundles

public int getNumBundles()

Specified by:

getNumBundles in interface LoadManagerReport

setNumBundles

public void setNumBundles(int numBundles)

getNumConsumers

public int getNumConsumers()

Specified by:

getNumConsumers in interface LoadManagerReport

setNumConsumers

public void setNumConsumers(int numConsumers)

getNumProducers

public int getNumProducers()

Specified by:

getNumProducers in interface LoadManagerReport

setNumProducers

public void setNumProducers(int numProducers)

getMsgThroughputIn

public double getMsgThroughputIn()

Specified by:

getMsgThroughputIn in interface LoadManagerReport

setMsgThroughputIn

public void setMsgThroughputIn(double msgThroughputIn)

getMsgThroughputOut

public double getMsgThroughputOut()

Specified by:

getMsgThroughputOut in interface LoadManagerReport

setMsgThroughputOut

public void setMsgThroughputOut(double msgThroughputOut)

getMsgRateIn

public double getMsgRateIn()

Specified by:

getMsgRateIn in interface LoadManagerReport

setMsgRateIn

public void setMsgRateIn(double msgRateIn)

getMsgRateOut

public double getMsgRateOut()

Specified by:

getMsgRateOut in interface LoadManagerReport

setMsgRateOut

public void setMsgRateOut(double msgRateOut)

setBrokerVersionString

public void setBrokerVersionString(String brokerVersionString)

getBrokerVersionString

public String getBrokerVersionString()

Specified by:

getBrokerVersionString in interface LoadManagerReport

getWebServiceUrl

public String getWebServiceUrl()

Specified by:

getWebServiceUrl in interface ServiceLookupData

getWebServiceUrlTls

public String getWebServiceUrlTls()

Specified by:

getWebServiceUrlTls in interface ServiceLookupData

getPulsarServiceUrl

public String getPulsarServiceUrl()

Specified by:

getPulsarServiceUrl in interface ServiceLookupData

getPulsarServiceUrlTls

public String getPulsarServiceUrlTls()

Specified by:

getPulsarServiceUrlTls in interface ServiceLookupData

isPersistentTopicsEnabled

public boolean isPersistentTopicsEnabled()

Specified by:

isPersistentTopicsEnabled in interface LoadManagerReport

setPersistentTopicsEnabled

public void setPersistentTopicsEnabled(boolean persistentTopicsEnabled)

isNonPersistentTopicsEnabled

public boolean isNonPersistentTopicsEnabled()

Specified by:

isNonPersistentTopicsEnabled in interface LoadManagerReport

setNonPersistentTopicsEnabled

public void setNonPersistentTopicsEnabled(boolean nonPersistentTopicsEnabled)

getBundleStats

public Map<String,NamespaceBundleStats> getBundleStats()

Specified by:

getBundleStats in interface LoadManagerReport

setProtocols

public void setProtocols(Map<String,String> protocols)

getProtocols

public Map<String,String> getProtocols()

Specified by:

getProtocols in interface ServiceLookupData

getProtocol

public Optional<String> getProtocol(String protocol)

Specified by:

getProtocol in interface ServiceLookupData

getAdvertisedListeners

public Map<String,AdvertisedListener> getAdvertisedListeners()

setAdvertisedListeners

public void setAdvertisedListeners(Map<String,AdvertisedListener> advertisedListeners)

getLoadManagerClassName

public String getLoadManagerClassName()

Specified by:

getLoadManagerClassName in interface ServiceLookupData

setLoadManagerClassName

public void setLoadManagerClassName(String loadManagerClassName)

getStartTimestamp

public long getStartTimestamp()

Specified by:

getStartTimestamp in interface ServiceLookupData