Broker load balancer

If you want to develop a broker load balancer, check out the following docs.

Pulsar has the following types of load managers:

  • Simple load manager, implemented in SimpleLoadManagerImpl, which attempts to simplify how the load is managed while also providing abstractions so that complex load management strategies may be implemented.

  • Modular load manager, implemented in ModularLoadManagerImpl, which is a flexible alternative to the SimpleLoadManagerImpl.

  • Extensible load manager, implemented in ExtensibleLoadManagerImpl, which is dependent on system topics and table views for load balance metadata store and replication.

Concepts

Before starting the impelemtation, make sure you understand the following basics.

Broker load balancer - 图1note

The following concepts are only availabe for the modular load manager.

Data

The data monitored by the modular load manager is contained in the LoadData class. Here, the available data is subdivided into the bundle data and the broker data.

Broker

The broker data is contained in the BrokerData class. It is further subdivided into two parts, one being the local data that every broker individually writes to ZooKeeper, and the other being the historical broker data that is written to ZooKeeper by the leader broker.

Lead broker

The module load manager is centralized, meaning that all requests to assign a bundle—-whether it’s been seen before or whether this is the first time—-only get handled by the lead broker (which can change over time). To determine the current lead broker, examine the /loadbalance/leader node in ZooKeeper.

Local broker data

The local broker data is contained in the class LocalBrokerData and provides information about the following resources:

  • CPU usage
  • JVM heap memory usage
  • Direct memory usage
  • Bandwidth in/out usage
  • Most recent total message rate in/out across all bundles
  • Total number of topics, bundles, producers, and consumers
  • Names of all bundles assigned to this broker
  • Most recent changes in bundle assignments for this broker

The local broker data is updated periodically according to the service configuration “loadBalancerReportUpdateMaxIntervalMinutes”. After any broker updates their local broker data, the leader broker will receive the update immediately via a ZooKeeper watch, where the local data is read from the ZooKeeper node /loadbalance/brokers/<broker host/port>

Historical broker data

The historical broker data is contained in the TimeAverageBrokerData class.

To reconcile the need to make good decisions in a steady-state scenario and make reactive decisions in a critical scenario, the historical data is split into two parts: the short-term data for reactive decisions, and the long-term data for steady-state decisions. Both time frames maintain the following information:

  • Message rate in/out for the entire broker
  • Message throughput in/out for the entire broker

Unlike the bundle data, the broker data does not maintain samples for the global broker message rates and throughputs, which is not expected to remain steady as new bundles are removed or added. Instead, this data is aggregated over the short-term and long-term data for the bundles. See the section on bundle data to understand how that data is collected and maintained.

The historical broker data is updated for each broker in memory by the leader broker whenever any broker writes their local data to ZooKeeper. Then, the historical data is written to ZooKeeper by the leader broker periodically according to the configuration loadBalancerResourceQuotaUpdateIntervalMinutes.

Bundle data

The bundle data is contained in the BundleData. Like the historical broker data, the bundle data is split into a short-term and long-term time frame. The information maintained in each time frame:

  • Message rate in/out for this bundle
  • Message Throughput In/Out for this bundle
  • Current number of samples for this bundle

The time frames are implemented by maintaining the average of these values over a set, a limited number of samples, where the samples are obtained through the message rate and throughput values in the local data. Thus, if the update interval for the local data is 2 minutes, the number of short samples is 10 and the number of long samples is 1000, the short-term data is maintained over a period of 10 samples * 2 minutes / sample = 20 minutes, while the long-term data is similarly over a period of 2000 minutes. Whenever there are not enough samples to satisfy a given time frame, the average is taken only over the existing samples. When no samples are available, default values are assumed until they are overwritten by the first sample. Currently, the default values are

  • Message rate in/out: 50 messages per second both ways
  • Message throughput in/out: 50KB per second both ways

The bundle data is updated in memory on the leader broker whenever any broker writes their local data to ZooKeeper. Then, the bundle data is written to ZooKeeper by the leader broker periodically at the same time as the historical broker data, according to the configuration loadBalancerResourceQuotaUpdateIntervalMinutes.

Traffic distribution

The modular load manager uses the abstraction provided by ModularLoadManagerStrategy to make decisions about bundle assignments. The strategy makes a decision by considering the service configuration, the entire load data, and the bundle data for the bundle to be assigned. Currently, the only supported strategy is LeastLongTermMessageRate, though soon users will have the ability to inject their own strategies if desired.

Least long term message rate strategy

As its name suggests, the least long-term message rate strategy attempts to distribute bundles across brokers so that the message rate in the long-term time window for each broker is roughly the same. However, simply balancing load based on message rate does not handle the issue of asymmetric resource burden per message on each broker. Thus, the system resource usages, which are CPU, memory, direct memory, bandwidth in, and bandwidth out, are also considered in the assignment process. This is done by weighting the final message rate according to 1 / (overload_threshold - max_usage), where overload_threshold corresponds to the configuration loadBalancerBrokerOverloadedThresholdPercentage and max_usage is the maximum proportion among the system resources that are being utilized by the candidate broker. This multiplier ensures that machines with are being more heavily taxed by the same message rates will receive less load. In particular, it tries to ensure that if one machine is overloaded, then all machines are approximately overloaded. In the case in which a broker’s max usage exceeds the overload threshold, that broker is not considered for bundle assignment. If all brokers are overloaded, the bundle is randomly assigned.

Enablement

You can enable a simple, modular, or extensible load manager by following the steps below.

Broker load balancer - 图2note

For simple and modular load managers:

  • Any mistakes in specifying the load manager will cause Pulsar to default to SimpleLoadManagerImpl.

  • If you do not specify load manager, the default load manager (ModularLoadManagerImpl) is used.

Enable simple load manager

You can enable the simple load manager using one of the following methods:

  • Method 1

    Update the value of loadManagerClassName to org.apache.pulsar.broker.loadbalance.impl.SimpleLoadManagerImpl in conf/broker.conf.

  • Method 2

    Use the pulsar-admin tool.

    1. pulsar-admin brokers update-dynamic-config \
    2. --config loadManagerClassName \
    3. --value org.apache.pulsar.broker.loadbalance.impl.SimpleLoadManagerImpl

Enable modular load manager

You can enable the modular load manager using one of the following methods:

  • Method 1

    Update the value of loadManagerClassName to org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl in conf/broker.conf.

  • Method 2

    Use the pulsar-admin tool.

    1. pulsar-admin brokers update-dynamic-config \
    2. --config loadManagerClassName \
    3. --value org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl

Enable extensible load manager

You can enable the extensible load manager by updating the value of loadManagerClassName to org.apache.pulsar.broker.loadbalance.impl.ExtensibleLoadManagerImpl in conf/broker.conf.

Broker load balancer - 图3note

The pulsar-admin tool is not supported for enabling the extensible load manager.

Verification

If you want to verify which load manager is used, follow the steps below.

Step 1: check loadManagerClassName

You can use the pulsar-admin tool to examine the loadManagerClassName element.

Input

  1. bin/pulsar-admin brokers get-all-dynamic-config

Output

  1. {
  2. "loadManagerClassName" : "org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl"
  3. }

If there is no loadManagerClassName element, then the value of loadManagerClassName in the conf/broker.conf file is used.

Step 2: verify load manager (optional)

To double-check which load manager is used, you can check the ZooKeeper load report or check monitor-brokers output.

Method 1: check load report

Different load managers have different load reports. You can verify which load manager is used based on the output.

  • Simple
  • Modular
  • Extensible

You can check ZooKeeper load reports.

  1. Connect to ZooKeeper.

    Input

    1. bin/pulsar zookeeper-shell -server zookeeper:2181

    Output

    1. Connecting to zookeeper:2181
    2. 2023-08-02T12:48:58,655+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:zookeeper.version=3.8.1-74db005175a4ec545697012f9069cb9dcc8cdda7, built on 2023-01-25 16:31 UTC
    3. 2023-08-02T12:48:58,662+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:host.name=broker-1
    4. 2023-08-02T12:48:58,662+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:java.version=17.0.7
    5. 2023-08-02T12:48:58,662+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:java.vendor=Eclipse Adoptium
    6. 2023-08-02T12:48:58,662+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:java.home=/usr/lib/jvm/temurin-17-jdk-amd64

  2. List all brokers.

    Input

    1. ls /loadbalance/brokers

    Output

    This output shows that there are 2 brokers.

    1. [broker-1:8080, broker-2:8080]

  3. Check ZooKeeper load report for broker 1. The load report in /loadbalance/brokers/....

    Input

    1. get /loadbalance/brokers/broker-1:8080

    Output

    1. {"name":"broker-1:8080","brokerVersionString":"3.1.0-SNAPSHOT","webServiceUrl":"http://broker-1:8080","pulsarServiceUrl":"pulsar://broker-1:6650","persistentTopicsEnabled":true,"nonPersistentTopicsEnabled":true,"timestamp":1691042931108,"msgRateIn":0.0,"msgRateOut":0.0,"numTopics":0,"numConsumers":0,"numProducers":0,"numBundles":0,"protocols":{},"loadManagerClassName":"org.apache.pulsar.broker.loadbalance.impl.SimpleLoadManagerImpl","startTimestamp":1691042931108,"systemResourceUsage":{"bandwidthIn":{"usage":0.595387281695773,"limit":1.0E7},"bandwidthOut":{"usage":0.5799226769764033,"limit":1.0E7},"cpu":{"usage":6.224803359552059,"limit":800.0},"memory":{"usage":152.0,"limit":2096.0},"directMemory":{"usage":0.0,"limit":256.0}},"bundleStats":{},"bundleGains":[],"bundleLosses":[],"allocatedCPU":0.0,"allocatedMemory":0.0,"allocatedBandwidthIn":0.0,"allocatedBandwidthOut":0.0,"allocatedMsgRateIn":0.0,"allocatedMsgRateOut":0.0,"preAllocatedCPU":0.0,"preAllocatedMemory":0.0,"preAllocatedBandwidthIn":0.0,"preAllocatedBandwidthOut":0.0,"preAllocatedMsgRateIn":0.0,"preAllocatedMsgRateOut":0.0,"underLoaded":true,"overLoaded":false,"loadReportType":"LoadReport","msgThroughputIn":0.0,"msgThroughputOut":0.0,"bandwidthIn":{"usage":0.595387281695773,"limit":1.0E7},"bandwidthOut":{"usage":0.5799226769764033,"limit":1.0E7},"memory":{"usage":152.0,"limit":2096.0},"cpu":{"usage":6.224803359552059,"limit":800.0},"directMemory":{"usage":0.0,"limit":256.0},"lastUpdate":1691042931108}

You can check ZooKeeper load reports.

  1. Connect to ZooKeeper.

    Input

    1. bin/pulsar zookeeper-shell -server zookeeper:2181

    Output

    1. Connecting to zookeeper:2181
    2. 2023-08-02T12:48:58,655+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:zookeeper.version=3.8.1-74db005175a4ec545697012f9069cb9dcc8cdda7, built on 2023-01-25 16:31 UTC
    3. 2023-08-02T12:48:58,662+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:host.name=broker-1
    4. 2023-08-02T12:48:58,662+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:java.version=17.0.7
    5. 2023-08-02T12:48:58,662+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:java.vendor=Eclipse Adoptium
    6. 2023-08-02T12:48:58,662+0000 [main] INFO  org.apache.zookeeper.ZooKeeper - Client environment:java.home=/usr/lib/jvm/temurin-17-jdk-amd64

  2. List all brokers.

    Input

    1. ls /loadbalance/brokers

    Output

    This output shows that there are 2 brokers.

    1. [broker-1:8080, broker-2:8080]

  3. Check ZooKeeper load report for broker 1. The load report in /loadbalance/brokers/....

    Input

    1. get /loadbalance/brokers/broker-1:8080

    Output

    1. {"webServiceUrl":"http://broker-1:8080","pulsarServiceUrl":"pulsar://broker-1:6650","persistentTopicsEnabled":true,"nonPersistentTopicsEnabled":true,"cpu":{"usage":7.311714728372232,"limit":800.0},"memory":{"usage":124.0,"limit":2096.0},"directMemory":{"usage":36.0,"limit":256.0},"bandwidthIn":{"usage":0.8324254085661579,"limit":1.0E7},"bandwidthOut":{"usage":0.7155446715644209,"limit":1.0E7},"msgThroughputIn":0.0,"msgThroughputOut":0.0,"msgRateIn":0.0,"msgRateOut":0.0,"lastUpdate":1690979816792,"lastStats":{"my-tenant/my-namespace/0x4ccccccb_0x66666664":{"msgRateIn":0.0,"msgThroughputIn":0.0,"msgRateOut":0.0,"msgThroughputOut":0.0,"consumerCount":2,"producerCount":0,"topics":1,"cacheSize":0}},"numTopics":1,"numBundles":1,"numConsumers":2,"numProducers":0,"bundles":["my-tenant/my-namespace/0x4ccccccb_0x66666664"],"lastBundleGains":[],"lastBundleLosses":[],"brokerVersionString":"3.1.0-SNAPSHOT","protocols":{},"advertisedListeners":{"internal":{"brokerServiceUrl":"pulsar://broker-1:6650"}},"loadManagerClassName":"org.apache.pulsar.broker.loadbalance.impl.ModularLoadManagerImpl","startTimestamp":1690940955211,"maxResourceUsage":0.140625,"loadReportType":"LocalBrokerData"}

Broker load balancer - 图4note

Extensible load manager does not have the ZooKeepr load report because its internal stats are stored in system topics rather than ZooKeeper.

You can check load report from system topics using the pulsar-client tool.

Input

  1. bin/pulsar-client consume non-persistent://pulsar/system/loadbalancer-broker-load-data --subscription-name test

Output

  1. 2023-08-03T06:21:48,841+0000 [pulsar-client-io-1-3] INFO  org.apache.pulsar.client.impl.ConnectionPool - [[id: 0x69a65535, L:/127.0.0.1:59086 - R:localhost/127.0.0.1:6650]] Connected to server
  2. 2023-08-03T06:21:48,926+0000 [pulsar-client-io-1-3] WARN  org.apache.pulsar.client.impl.ConsumerImpl - [non-persistent://pulsar/system/loadbalancer-broker-load-data] Cannot create a [Durable] subscription for a NonPersistentTopic, will use [NonDurable] to subscribe. Subscription name: test
  3. 2023-08-03T06:21:49,189+0000 [pulsar-client-io-1-3] INFO  org.apache.pulsar.client.impl.ConsumerStatsRecorderImpl - Starting Pulsar consumer status recorder with config: {"topicNames":["non-persistent://pulsar/system/loadbalancer-broker-load-data"],"topicsPattern":null,"subscriptionName":"test","subscriptionType":"Exclusive","subscriptionProperties":null,"subscriptionMode":"NonDurable","receiverQueueSize":1000,"acknowledgementsGroupTimeMicros":100000,"maxAcknowledgmentGroupSize":1000,"negativeAckRedeliveryDelayMicros":60000000,"maxTotalReceiverQueueSizeAcrossPartitions":50000,"consumerName":null,"ackTimeoutMillis":0,"tickDurationMillis":1000,"priorityLevel":0,"maxPendingChunkedMessage":10,"autoAckOldestChunkedMessageOnQueueFull":false,"expireTimeOfIncompleteChunkedMessageMillis":60000,"cryptoFailureAction":"FAIL","properties":{},"readCompacted":false,"subscriptionInitialPosition":"Latest","patternAutoDiscoveryPeriod":60,"regexSubscriptionMode":"PersistentOnly","deadLetterPolicy":null,"retryEnable":false,"autoUpdatePartitions":true,"autoUpdatePartitionsIntervalSeconds":60,"replicateSubscriptionState":false,"resetIncludeHead":false,"batchIndexAckEnabled":false,"ackReceiptEnabled":false,"poolMessages":true,"startPaused":false,"autoScaledReceiverQueueSizeEnabled":false,"topicConfigurations":[],"maxPendingChuckedMessage":10}
  4. 2023-08-03T06:21:49,214+0000 [pulsar-client-io-1-3] INFO  org.apache.pulsar.client.impl.ConsumerStatsRecorderImpl - Pulsar client config: {"serviceUrl":"pulsar://localhost:6650/","authPluginClassName":null,"authParams":null,"authParamMap":null,"operationTimeoutMs":30000,"lookupTimeoutMs":30000,"statsIntervalSeconds":60,"numIoThreads":8,"numListenerThreads":8,"connectionsPerBroker":1,"connectionMaxIdleSeconds":180,"useTcpNoDelay":true,"useTls":false,"tlsKeyFilePath":"","tlsCertificateFilePath":"","tlsTrustCertsFilePath":"","tlsAllowInsecureConnection":false,"tlsHostnameVerificationEnable":false,"concurrentLookupRequest":5000,"maxLookupRequest":50000,"maxLookupRedirects":20,"maxNumberOfRejectedRequestPerConnection":50,"keepAliveIntervalSeconds":30,"connectionTimeoutMs":10000,"requestTimeoutMs":60000,"readTimeoutMs":60000,"autoCertRefreshSeconds":300,"initialBackoffIntervalNanos":100000000,"maxBackoffIntervalNanos":60000000000,"enableBusyWait":false,"listenerName":null,"useKeyStoreTls":false,"sslProvider":null,"tlsKeyStoreType":"JKS","tlsKeyStorePath":"","tlsKeyStorePassword":"*****","tlsTrustStoreType":"JKS","tlsTrustStorePath":"","tlsTrustStorePassword":"*****","tlsCiphers":[],"tlsProtocols":[],"memoryLimitBytes":0,"proxyServiceUrl":null,"proxyProtocol":null,"enableTransaction":false,"dnsLookupBindAddress":null,"dnsLookupBindPort":0,"socks5ProxyAddress":null,"socks5ProxyUsername":null,"socks5ProxyPassword":null,"description":null}
  5. 2023-08-03T06:21:49,236+0000 [pulsar-client-io-1-5] INFO  org.apache.pulsar.client.impl.ConnectionPool - [[id: 0xbeee21f2, L:/172.31.0.4:44850 - R:broker-1/172.31.0.4:6650]] Connected to server
  6. 2023-08-03T06:21:49,241+0000 [pulsar-client-io-1-5] INFO  org.apache.pulsar.client.impl.ConsumerImpl - [non-persistent://pulsar/system/loadbalancer-broker-load-data][test] Subscribing to topic on cnx [id: 0xbeee21f2, L:/172.31.0.4:44850 - R:broker-1/172.31.0.4:6650], consumerId 0
  7. 2023-08-03T06:21:49,273+0000 [pulsar-client-io-1-5] INFO  org.apache.pulsar.client.impl.ConsumerImpl - [non-persistent://pulsar/system/loadbalancer-broker-load-data][test] Subscribed to topic on broker-1/172.31.0.4:6650 -- consumer: 0
  8. ----- got message -----
  9. key:[broker-1:8080], properties:[], content:{"cpu":{"usage":14.397985201479854,"limit":800.0},"memory":{"usage":300.0,"limit":2096.0},"directMemory":{"usage":40.0,"limit":256.0},"bandwidthIn":{"usage":0.7817884878178855,"limit":1.0E7},"bandwidthOut":{"usage":0.7213945272139455,"limit":1.0E7},"msgThroughputIn":3.000538680274058,"msgThroughputOut":3.0005621893825616,"msgRateIn":0.03333931866971176,"msgRateOut":0.033339579882028465,"bundleCount":3,"topics":3,"maxResourceUsage":0.15625,"weightedMaxEMA":0.15625,"msgThroughputEMA":38.88925615962549,"updatedAt":1691043751060,"reportedAt":1691043631073}

Method 2: check monitor-brokers output

You can use the pulsar-perf tool to start a broker monitor.

Different load managers have different outputs. This output is the same as the output of the Method 1: check ZooKeeper load report, but it is well formatted for better readability.

  • Simple
  • Modular
  • Extensible

Input

  1. pulsar-perf monitor-brokers --connect-string <zookeeper host:port>

Output

  1. ===================================================================================================================
  2. ||COUNT          |TOPIC          |BUNDLE         |PRODUCER       |CONSUMER       |BUNDLE +       |BUNDLE -       ||
  3. ||               |4              |4              |0              |2              |0              |0              ||
  4. ||RAW SYSTEM     |CPU %          |MEMORY %       |DIRECT %       |BW IN %        |BW OUT %       |MAX %          ||
  5. ||               |0.25           |47.94          |0.01           |0.00           |0.00           |47.94          ||
  6. ||ALLOC SYSTEM   |CPU %          |MEMORY %       |DIRECT %       |BW IN %        |BW OUT %       |MAX %          ||
  7. ||               |0.20           |1.89           |               |1.27           |3.21           |3.21           ||
  8. ||RAW MSG        |MSG/S IN       |MSG/S OUT      |TOTAL          |KB/S IN        |KB/S OUT       |TOTAL          ||
  9. ||               |0.00           |0.00           |0.00           |0.01           |0.01           |0.01           ||
  10. ||ALLOC MSG      |MSG/S IN       |MSG/S OUT      |TOTAL          |KB/S IN        |KB/S OUT       |TOTAL          ||
  11. ||               |54.84          |134.48         |189.31         |126.54         |320.96         |447.50         ||
  12. ===================================================================================================================

Input

  1. pulsar-perf monitor-brokers --connect-string <zookeeper host:port>

Output

  1. ===================================================================================================================
  2. ||SYSTEM         |CPU %          |MEMORY %       |DIRECT %       |BW IN %        |BW OUT %       |MAX %          ||
  3. ||               |0.00           |48.33          |0.01           |0.00           |0.00           |48.33          ||
  4. ||COUNT          |TOPIC          |BUNDLE         |PRODUCER       |CONSUMER       |BUNDLE +       |BUNDLE -       ||
  5. ||               |4              |4              |0              |2              |4              |0              ||
  6. ||LATEST         |MSG/S IN       |MSG/S OUT      |TOTAL          |KB/S IN        |KB/S OUT       |TOTAL          ||
  7. ||               |0.00           |0.00           |0.00           |0.00           |0.00           |0.00           ||
  8. ||SHORT          |MSG/S IN       |MSG/S OUT      |TOTAL          |KB/S IN        |KB/S OUT       |TOTAL          ||
  9. ||               |0.00           |0.00           |0.00           |0.00           |0.00           |0.00           ||
  10. ||LONG           |MSG/S IN       |MSG/S OUT      |TOTAL          |KB/S IN        |KB/S OUT       |TOTAL          ||
  11. ||               |0.00           |0.00           |0.00           |0.00           |0.00           |0.00           ||
  12. ===================================================================================================================

Input

  1. pulsar-perf monitor-brokers --connect-string pulsar://<host:port> --extensions

Output

  1. ===================================================================================================================
  2. ||SYSTEM         |CPU %          |MEMORY %       |DIRECT %       |BW IN %        |BW OUT %       |MAX %          ||
  3. ||               |17.24          |12.40          |26.95          |0.00           |0.00           |26.95          ||
  4. ||COUNT          |TOPIC          |BUNDLE         |PRODUCER       |CONSUMER       |BUNDLE +       |BUNDLE -       ||
  5. ||               |               |4              |               |               |               |               ||
  6. ||LATEST         |MSG/S IN       |MSG/S OUT      |TOTAL          |KB/S IN        |KB/S OUT       |TOTAL          ||
  7. ||               |100.02         |0.02           |100.03         |103.89         |0.01           |103.90         ||
  8. ===================================================================================================================

````