This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new afc48e64cb1 [feature][doc] Add a note for restarting brokers with the
load shedding strategy dynamically updated
afc48e64cb1 is described below
commit afc48e64cb161eb3fd1e00f5f997ea8f00fe66ab
Author: momo-jun <[email protected]>
AuthorDate: Thu May 5 21:05:05 2022 +0800
[feature][doc] Add a note for restarting brokers with the load shedding
strategy dynamically updated
---
site2/docs/admin-api-brokers.md | 4 ++--
site2/docs/administration-load-balance.md | 5 ++++-
site2/docs/reference-configuration.md | 2 +-
3 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/site2/docs/admin-api-brokers.md b/site2/docs/admin-api-brokers.md
index 21972177292..be7716891b6 100644
--- a/site2/docs/admin-api-brokers.md
+++ b/site2/docs/admin-api-brokers.md
@@ -124,7 +124,7 @@ One way to configure a Pulsar
[broker](reference-terminology.md#broker) is to su
But since all broker configuration in Pulsar is stored in ZooKeeper,
configuration values can also be dynamically updated *while the broker is
running*. When you update broker configuration dynamically, ZooKeeper will
notify the broker of the change and the broker will then override any existing
configuration values.
-* The [`brokers`](reference-pulsar-admin.md#brokers) command for the
[`pulsar-admin`](reference-pulsar-admin.md) tool has a variety of subcommands
that enable you to manipulate a broker's configuration dynamically, enabling
you to [update config values](#update-dynamic-configuration) and more.
+* The `brokers` command for the
[`pulsar-admin`](https://pulsar.apache.org/tools/pulsar-admin/) tool has a
variety of subcommands that enable you to manipulate a broker's configuration
dynamically, enabling you to [update config
values](#update-dynamic-configuration) and more.
* In the Pulsar admin {@inject: rest:REST:/} API, dynamic configuration is
managed through the `/admin/v2/brokers/configuration` endpoint.
### Update dynamic configuration
@@ -132,7 +132,7 @@ But since all broker configuration in Pulsar is stored in
ZooKeeper, configurati
<!--DOCUSAURUS_CODE_TABS-->
<!--pulsar-admin-->
-The
[`update-dynamic-config`](reference-pulsar-admin.md#brokers-update-dynamic-config)
subcommand will update existing configuration. It takes two arguments: the
name of the parameter and the new value using the `config` and `value` flag
respectively. Here's an example for the
[`brokerShutdownTimeoutMs`](reference-configuration.md#broker-brokerShutdownTimeoutMs)
parameter:
+The [`update-dynamic-config`](https://pulsar.apache.org/tools/pulsar-admin/)
subcommand will update existing configuration. It takes two arguments: the name
of the parameter and the new value using the `config` and `value` flag
respectively. Here's an example for the
[`brokerShutdownTimeoutMs`](reference-configuration.md#broker-brokerShutdownTimeoutMs)
parameter:
```shell
$ pulsar-admin brokers update-dynamic-config --config brokerShutdownTimeoutMs
--value 100
diff --git a/site2/docs/administration-load-balance.md
b/site2/docs/administration-load-balance.md
index 9035087bc34..8fb7a276b00 100644
--- a/site2/docs/administration-load-balance.md
+++ b/site2/docs/administration-load-balance.md
@@ -143,6 +143,9 @@ loadBalancerSheddingGracePeriodMinutes=30
Pulsar supports the following types of shedding strategies. From Pulsar 2.10,
the **default** shedding strategy is `ThresholdShedder`.
+> **Note**<br />
+> You need to restart brokers if the shedding strategy is [dynamically
updated](admin-api-brokers.md/#dynamic-broker-configuration).
+
##### ThresholdShedder
This strategy tends to shed the bundles if any broker's usage is above the
configured threshold. It does this by first computing the average resource
usage per broker for the whole cluster. The resource usage for each broker is
calculated using the following method:
LocalBrokerData#getMaxResourceUsageWithWeight. The weights for each resource
are configurable. Historical observations are included in the running average
based on the broker's setting for loadBalancerHistoryResourcePercentag [...]
`loadBalancerLoadSheddingStrategy=org.apache.pulsar.broker.loadbalance.impl.ThresholdShedder`
@@ -156,7 +159,7 @@ This strategy will attempt to shed exactly one bundle on
brokers which are overl
##### UniformLoadShedder
-This strategy tends to distribute load uniformly across all brokers. This
strategy checks laod difference between broker with highest load and broker
with lowest load. If the difference is higher than configured thresholds
`loadBalancerMsgRateDifferenceShedderThreshold` and
`loadBalancerMsgThroughputMultiplierDifferenceShedderThreshold` then it finds
out bundles which can be unloaded to distribute traffic evenly across all
brokers. Configure broker with below value to use this strategy.
+This strategy tends to distribute load uniformly across all brokers. This
strategy checks load difference between broker with highest load and broker
with lowest load. If the difference is higher than configured thresholds
`loadBalancerMsgRateDifferenceShedderThreshold` and
`loadBalancerMsgThroughputMultiplierDifferenceShedderThreshold` then it finds
out bundles which can be unloaded to distribute traffic evenly across all
brokers. Configure broker with below value to use this strategy.
`loadBalancerLoadSheddingStrategy=org.apache.pulsar.broker.loadbalance.impl.UniformLoadShedder`
diff --git a/site2/docs/reference-configuration.md
b/site2/docs/reference-configuration.md
index 53709fe06e3..6a497dd779a 100644
--- a/site2/docs/reference-configuration.md
+++ b/site2/docs/reference-configuration.md
@@ -329,7 +329,7 @@ brokerServiceCompactionThresholdInBytes|If the estimated
backlog size is greater
|loadBalancerNamespaceBundleMaxMsgRate| maximum msgRate (in + out) in a
bundle, otherwise bundle split will be triggered |1000|
|loadBalancerNamespaceBundleMaxBandwidthMbytes| maximum bandwidth (in + out)
in a bundle, otherwise bundle split will be triggered |100|
|loadBalancerNamespaceMaximumBundles| maximum number of bundles in a namespace
|128|
-|loadBalancerLoadSheddingStrategy | The shedding strategy of load balance. <br
/><br />Available values:
<li>`org.apache.pulsar.broker.loadbalance.impl.ThresholdShedder`</li><li>`org.apache.pulsar.broker.loadbalance.impl.OverloadShedder`</li><li>`org.apache.pulsar.broker.loadbalance.impl.UniformLoadShedder`</li><br
/>For the comparisons of the shedding strategies, see
[here](administration-load-balance/#shed-load-automatically).|`org.apache.pulsar.broker.loadbalance.impl.ThresholdShedder`
+|loadBalancerLoadSheddingStrategy | The shedding strategy of load balance. <br
/><br />Available values:
<li>`org.apache.pulsar.broker.loadbalance.impl.ThresholdShedder`</li><li>`org.apache.pulsar.broker.loadbalance.impl.OverloadShedder`</li><li>`org.apache.pulsar.broker.loadbalance.impl.UniformLoadShedder`</li><br
/>For the comparisons of the shedding strategies, see
[here](administration-load-balance/#shed-load-automatically).<br />**Note**:
You need to restart brokers if this configur [...]
|replicationMetricsEnabled| Enable replication metrics |true|
|replicationConnectionsPerBroker| Max number of connections to open for each
broker in a remote cluster More connections host-to-host lead to better
throughput over high-latency links. |16|
|replicationProducerQueueSize| Replicator producer queue size |1000|
