(pulsar) branch master updated: [fix] Fix incorrect unit and doc for `loadBalancerReportUpdateMaxIntervalMinutes` (#21448)

[houxiaoyu]

This is an automated email from the ASF dual-hosted git repository.

houxiaoyu 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 b010bab6b0d [fix] Fix incorrect unit and doc for 
`loadBalancerReportUpdateMaxIntervalMinutes` (#21448)
b010bab6b0d is described below

commit b010bab6b0d2a304dabdbe6bd825226de0358349
Author: Zike Yang <z...@apache.org>
AuthorDate: Sat Oct 28 11:19:05 2023 +0800

    [fix] Fix incorrect unit and doc for 
`loadBalancerReportUpdateMaxIntervalMinutes` (#21448)
    
    ### Motivation
    The documentation inaccurately represents the unit for 
loadBalancerReportUpdateMaxIntervalMinutes - it is actually in minutes, not 
seconds. Additionally, the explanation for 
loadBalancerBrokerLoadDataTTLInSeconds is unclear.
    ```
    "The current default is loadBalancerReportUpdateMaxIntervalMinutes * 2. "
    ```
    Actually, it numerically equates to 
loadBalancerReportUpdateMaxIntervalMinutes * 120.
    
    ### Modifications
    - Correct the documentation
---
 .../src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git 
a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
 
b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
index 82ddedd89ac..27b302ea839 100644
--- 
a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
+++ 
b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
@@ -2243,7 +2243,7 @@ public class ServiceConfiguration implements 
PulsarConfiguration {
     @FieldContext(
             category = CATEGORY_LOAD_BALANCER,
             dynamic = true,
-            doc = "Min delay of load report to collect, in milli-seconds"
+            doc = "Min delay of load report to collect, in minutes"
     )
     private int loadBalancerReportUpdateMaxIntervalMinutes = 15;
     @FieldContext(
@@ -2594,7 +2594,8 @@ public class ServiceConfiguration implements 
PulsarConfiguration {
                     + "The logic tries to avoid (possibly unavailable) brokers 
with out-dated load data, "
                     + "and those brokers will be ignored in the load 
computation. "
                     + "When tuning this value, please consider 
loadBalancerReportUpdateMaxIntervalMinutes. "
-                    + "The current default is 
loadBalancerReportUpdateMaxIntervalMinutes * 2. "
+                    + "The current default value is 
loadBalancerReportUpdateMaxIntervalMinutes * 120, reflecting "
+                    + "twice the duration in seconds. "
                     + "(only used in load balancer extension TransferSheddeer)"
     )
     private long loadBalancerBrokerLoadDataTTLInSeconds = 1800;